cosmos 3.0.0

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

@@ -0,0 +1,287 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos'
+
+module Cosmos
+
+  class TlmViewerConfig
+
+    class ScreenInfo
+      attr_accessor :group
+      attr_accessor :target_name
+      attr_accessor :original_target_name
+      attr_accessor :name
+      attr_accessor :filename
+      attr_accessor :x_pos
+      attr_accessor :y_pos
+      attr_accessor :substitute
+      attr_accessor :force_substitute
+      attr_accessor :screen
+      attr_accessor :show_on_startup
+      attr_accessor :items
+      attr_accessor :invalid_items
+
+      def initialize(group, target_name, name, filename, x_pos, y_pos)
+        @group = group
+        @target_name = target_name.upcase
+        @original_target_name = nil
+        @name = name.upcase
+        @name = "#{@target_name} #{@name}" if group
+        @filename = filename
+        @x_pos = x_pos
+        @y_pos = y_pos
+        @substitute = nil
+        @force_substitute = false
+        @screen = nil
+        @show_on_startup = false
+        @items = []
+        @invalid_items = []
+      end
+
+      def full_name
+        @group ? @name : "#{@target_name} #{@name}"
+      end
+
+      def read_items
+        @items = []
+        @invalid_items = []
+        begin
+          parser = ConfigParser.new
+          parser.parse_file(@filename) do |keyword, parameters|
+            if keyword
+              case keyword
+              when 'SCREEN', 'END', 'SETTING', 'SUBSETTING', 'GLOBAL_SETTING', 'GLOBAL_SUBSETTING'
+                # Do nothing
+              else
+                if keyword == 'NAMED_WIDGET'
+                  keyword = parameters[1].to_s.upcase
+                  parameters = parameters[2..-1]
+                end
+
+                klass = Cosmos.require_class(keyword.downcase + '_widget')
+                if klass.takes_value?
+                  begin
+                    if @substitute and (@original_target_name == parameters[0].to_s.upcase or @force_substitute)
+                      System.telemetry.packet_and_item(@substitute, parameters[1], parameters[2])
+                      @items << "#{@substitute} #{parameters[1]} #{parameters[2]}".upcase
+                    else
+                      System.telemetry.packet_and_item(*parameters[0..2])
+                      @items << "#{parameters[0]} #{parameters[1]} #{parameters[2]}".upcase
+                    end
+                  rescue
+                    @invalid_items << "#{parameters[0]} #{parameters[1]} #{parameters[2]}".upcase
+                    next
+                  end
+                end
+              end # case keyword
+            end # if keyword
+          end # parser.parse_file
+        rescue Exception
+          # Oh well - Bad Screen
+        end
+      end
+    end
+
+    attr_accessor :columns
+    attr_accessor :screen_infos
+    attr_accessor :filename
+    attr_accessor :completion_list
+    attr_accessor :tlm_to_screen_mapping
+
+    def initialize(filename = nil)
+      # Handle nil filename
+      filename = File.join(Cosmos::USERPATH, 'config', 'tools', 'tlm_viewer', 'tlm_viewer.txt') unless filename
+      @filename = filename
+
+      # Ensure the file exists
+      raise "Telemetry Viewer configuration file #{filename} does not exist" unless test ?f, filename
+
+      # Initialize instance variables
+      @columns = []
+      @columns << {}
+      @screen_infos = {}
+
+      # Process File
+      @current_column = @columns[0]
+      @current_target = nil
+      @current_screens = nil
+      @current_screen_info = nil
+      @current_group = nil
+      parser = ConfigParser.new
+      parser.parse_file(filename) do |keyword, parameters|
+        case keyword
+
+        when 'NEW_COLUMN'
+          @columns << {}
+          @current_column = @columns[-1]
+
+        when 'AUTO_TARGETS'
+          parser.verify_num_parameters(0, 0, 'AUTO_TARGETS')
+          System.targets.each do |target_name, target|
+            screen_dir = File.join(Cosmos::USERPATH, 'config', 'targets', target.original_name, 'screens')
+            if File.exist?(screen_dir) and num_screens(screen_dir) > 0
+              start_target(target.name, parser)
+              auto_screens()
+            end
+          end
+
+        when 'AUTO_TARGET'
+          parser.verify_num_parameters(1, 1, 'AUTO_TARGET <Target Name>')
+          target_name = parameters[0].upcase
+          target = System.targets[target_name]
+          raise parser.error("Unknown target #{target_name}") unless target
+          screen_dir = File.join(Cosmos::USERPATH, 'config', 'targets', target.original_name, 'screens')
+          if File.exist?(screen_dir) and num_screens(screen_dir) > 0
+            start_target(target.name, parser)
+            auto_screens()
+          end
+
+        when 'TARGET'
+          parser.verify_num_parameters(1, 1, 'TARGET <Target Name>')
+          target_name = parameters[0].upcase
+          start_target(target_name, parser)
+
+        when 'SCREEN'
+          raise parser.error("No target defined. SCREEN must follow TARGET.") unless @current_target
+          parser.verify_num_parameters(1, 3, 'SCREEN <Filename> <X Position (optional)> <Y Position (optional)>')
+          screen_filename = File.join(Cosmos::USERPATH, 'config', 'targets', @current_target.original_name, 'screens', parameters[0])
+          start_screen(screen_filename, parameters[1], parameters[2])
+
+        when 'SHOW_ON_STARTUP'
+          raise parser.error("No screen defined. SHOW_ON_STARTUP must follow SCREEN or GROUP_SCREEN.") unless @current_screen_info
+          parser.verify_num_parameters(0, 0, 'SHOW_ON_STARTUP')
+          @current_screen_info.show_on_startup = true
+
+        when 'ADD_SHOW_ON_STARTUP'
+          parser.verify_num_parameters(2, 4, 'ADD_SHOW_ON_STARTUP <Target Name> <Screen Name> <X Position (optional)> <Y Position (optional)>')
+          @current_screen_info = @screen_infos["#{parameters[0]} #{parameters[1]}".upcase]
+          raise parser.error("Screen #{parameters[0]} #{parameters[1]} does not exist") unless @current_screen_info
+          @current_screen_info.show_on_startup = true
+          @current_screen_info.x_pos = parameters[2].to_i if parameters[2]
+          @current_screen_info.y_pos = parameters[3].to_i if parameters[3]
+
+        when 'GROUP'
+          parser.verify_num_parameters(1, 1, 'GROUP <Group Name>')
+          @current_group = parameters[0]
+          @current_screens = {}
+          @current_column[@current_group] = @current_screens
+
+        when 'GROUP_SCREEN'
+          raise parser.error("No group defined. GROUP_SCREEN must follow GROUP.") unless @current_group
+          parser.verify_num_parameters(2, 4, 'GROUP_SCREEN <Target Name> <Screen Filename> <X Position (optional)> <Y Position (Optional)>')
+          start_target(parameters[0].upcase, parser, @current_group)
+          screen_filename = File.join(Cosmos::USERPATH, 'config', 'targets', @current_target.original_name, 'screens', parameters[1])
+          start_screen(screen_filename, parameters[2], parameters[3])
+
+        else
+          # blank config.lines will have a nil keyword and should not raise an exception
+          raise parser.error("Unknown keyword '#{keyword}'") if keyword
+        end
+      end
+
+      build_completion_list()
+    end
+
+    def save(filename)
+      @filename = filename
+
+      File.open(filename, 'w') do |file|
+        @columns.each_with_index do |target_screen_infos, column_index|
+          if column_index != 0
+            file.puts ''
+            file.puts "NEW_COLUMN"
+            file.puts ''
+          end
+          target_screen_infos.each do |target_name, screen_infos|
+            file.puts "TARGET \"#{target_name}\""
+            screen_infos.each do |screen_name, screen_info|
+              screen_filename = screen_info.filename.gsub(File.join(Cosmos::USERPATH, 'config', 'targets', screen_info.original_target_name, 'screens', ''), '')
+              string = "  SCREEN"
+              string << " \"#{screen_filename}\""
+              string << " #{screen_info.x_pos}" if screen_info.x_pos
+              string << " #{screen_info.y_pos}" if screen_info.y_pos
+              file.puts string
+              if screen_info.screen
+                file.puts "    SHOW_ON_STARTUP"
+              end
+            end
+            file.puts ""
+          end
+        end
+      end
+    end
+
+    def start_target(target_name, parser, group = nil)
+      @current_target = System.targets[target_name]
+      raise parser.error("Unknown target #{target_name}") unless @current_target
+      # If no group was passed setup a new column and screen hash
+      unless group
+        @current_group = nil
+        @current_screens = {}
+        @current_column[target_name] = @current_screens
+      end
+    end
+
+    def start_screen(screen_filename, x_pos = nil, y_pos = nil)
+      screen_name = File.basename(screen_filename, '.txt').upcase
+      x_pos = x_pos.to_i if x_pos
+      y_pos = y_pos.to_i if y_pos
+
+      @current_screen_info = ScreenInfo.new(@current_group, @current_target.name, screen_name, screen_filename, x_pos, y_pos)
+      @screen_infos[@current_screen_info.full_name] = @current_screen_info
+      @current_screens["#{@current_target.name}_#{screen_name}"] = @current_screen_info
+      @current_screen_info.force_substitute = true if @current_target.auto_screen_substitute
+      @current_screen_info.original_target_name = @current_target.original_name
+      @current_screen_info.substitute = @current_target.name if @current_target.substitute or @current_target.auto_screen_substitute
+      @current_screen_info.read_items
+    end
+
+    def auto_screens
+      @current_group = nil
+      screen_dir = File.join(Cosmos::USERPATH, 'config', 'targets', @current_target.original_name, 'screens')
+      if File.exist?(screen_dir)
+        Dir.new(screen_dir).each do |filename|
+          if filename[0..0] != '.'
+            start_screen(File.join(screen_dir, filename))
+          end
+        end
+      end
+    end
+
+    def num_screens(screen_dir)
+      count = 0
+      Dir.new(screen_dir).each do |filename|
+        count += 1 if filename[0..0] != '.'
+      end
+      count
+    end
+
+    def build_completion_list
+      @completion_list = []
+      @tlm_to_screen_mapping = {}
+      total = @screen_infos.length.to_f
+      index = 1
+      ConfigParser.splash.message = "Building completion list" if ConfigParser.splash
+      @screen_infos.each do |name, info|
+        ConfigParser.splash.progress = index / total if ConfigParser.splash
+        info.items.each do |item|
+          @tlm_to_screen_mapping[item] ||= []
+          @tlm_to_screen_mapping[item] << name
+        end
+        @completion_list.concat(info.items)
+        index += 1
+      end
+      @completion_list.uniq!
+    end
+
+  end
+
+end # module Cosmos

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

@@ -0,0 +1,110 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos'
+
+module Cosmos
+
+  module AgingWidget
+
+    attr_accessor :coloring
+
+    def setup_aging
+      @previous_value = 0
+      @gray_level = 255
+      @enable_aging = true
+      @min_gray = 200
+      @gray_rate = 3
+      @gray_tolerance = nil
+      @colorblind = false
+      @coloring = true
+      @foreground = Cosmos::BLACK
+      @background = Cosmos::WHITE
+    end
+
+    module ClassMethods
+      def takes_value?
+        return true
+      end
+    end
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def value=(data, text = nil)
+      text = data.to_s unless text
+
+      if @coloring
+        case @limits_state
+        when :RED, :RED_HIGH
+          @foreground = Cosmos::RED
+          text << ' (R)' if @colorblind
+        when :RED_LOW
+          @foreground = Cosmos::RED
+          text << ' (r)' if @colorblind
+        when :YELLOW, :YELLOW_HIGH
+          @foreground = Cosmos::YELLOW
+          text << ' (Y)' if @colorblind
+        when :YELLOW_LOW
+          @foreground = Cosmos::YELLOW
+          text << ' (y)' if @colorblind
+        when :GREEN, :GREEN_HIGH
+          @foreground = Cosmos::GREEN
+          text << ' (G)' if @colorblind
+        when :GREEN_LOW
+          @foreground = Cosmos::GREEN
+          text << ' (g)' if @colorblind
+        when :BLUE
+          @foreground = Cosmos::BLUE
+          text << ' (B)' if @colorblind
+        when :STALE
+          @foreground = Cosmos::PURPLE
+          text << ' ($)' if @colorblind
+        else
+          @foreground = Cosmos::BLACK
+        end
+      end
+
+      # Implement Telemetry Aging
+      if @enable_aging
+        if (@previous_value == data) ||
+          (@gray_tolerance && ((@previous_value.to_f - data.to_f).abs <= @gray_tolerance))
+          @gray_level -= @gray_rate
+          @gray_level = @min_gray if @gray_level < @min_gray
+        else
+          @gray_level = 255
+        end
+        @background = Cosmos::getColor(@gray_level, @gray_level, @gray_level)
+        @previous_value = data
+      end
+      text
+    end
+
+    def process_aging_settings
+      @settings.each do |setting_name, setting_values|
+        case setting_name.upcase
+        when 'GRAY_RATE', 'GREY_RATE'
+          gray_rate = settings_values[0].to_i
+          @gray_rate = gray_rate
+        when 'MIN_GRAY', 'MIN_GREY'
+          gray = setting_values[0].to_i
+          @min_gray = gray unless gray < 0
+        when 'ENABLE_AGING'
+          enable_aging = ConfigParser::handle_true_false(setting_values[0])
+          @enable_aging = enable_aging
+        when 'COLORBLIND'
+          @colorblind = ConfigParser::handle_true_false(setting_values[0])
+        end
+      end
+    end
+
+  end
+
+end # module Cosmos

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

@@ -0,0 +1,70 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos'
+require 'cosmos/tools/tlm_viewer/widgets/widget'
+require 'cosmos/tools/tlm_viewer/widgets/aging_widget'
+
+module Cosmos
+
+  class ArrayWidget < Qt::TextEdit
+    include Widget
+    include AgingWidget
+
+    def initialize(parent_layout, target_name, packet_name, item_name, width = 200, height = 100, format_string = nil, items_per_row = 4, value_type = :CONVERTED)
+      super(target_name, packet_name, item_name, value_type)
+      setup_aging
+      @format_string = ConfigParser.handle_nil(format_string)
+      @items_per_row = items_per_row.to_i
+      setFixedSize(width.to_i, height.to_i)
+      setReadOnly(true)
+      if Kernel.is_windows?
+        setFont(Cosmos.getFont("courier", 10))
+      else
+        setFont(Cosmos.getFont("courier", 14))
+      end
+      parent_layout.addWidget(self) if parent_layout
+    end
+
+    def value=(data)
+      scroll_pos = self.verticalScrollBar.value
+      text = ""
+      space = ' '
+      new_line = "\n"
+      count = 0
+      if data.respond_to? :each
+        data.each do |value|
+          if @format_string
+            text << sprintf(@format_string, value) << space
+          else
+            text << value.to_s << space
+          end
+          count += 1
+          if (count % @items_per_row) == 0
+            count = 0
+            text << new_line
+          end
+        end
+      else
+        text = data.to_s
+      end
+      self.text = super(data, text)
+      self.setColors(@foreground, @background)
+      self.verticalScrollBar.value = scroll_pos
+    end
+
+    def process_settings
+      super
+      process_aging_settings
+    end
+
+  end
+
+end # module Cosmos

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

@@ -0,0 +1,61 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+# This file contains the implementation and BlockWidget class.   This class
+# implements the block widget to display block data
+
+require 'cosmos'
+require 'cosmos/tools/tlm_viewer/widgets/textbox_widget'
+
+module Cosmos
+
+  class BlockWidget < TextboxWidget
+
+    def initialize (parent_layout, target_name, packet_name, item_name, width = 200, height = 100, format_string = "%02X", bytes_per_word = 4, words_per_row = 4, addr_format = nil, value_type = :RAW)
+      super(parent_layout, target_name, packet_name, item_name, width, height, value_type)
+      @format_string = format_string.to_s
+      @bytes_per_word = bytes_per_word.to_i
+      @words_per_row  = words_per_row.to_i
+      @bytes_per_row  = @bytes_per_word * @words_per_row
+      @addr_format = ConfigParser.handle_nil(addr_format)
+      @addr_format << ' ' if @addr_format
+      if Kernel.is_windows?
+        setFont(Cosmos.getFont("courier", 10))
+      else
+        setFont(Cosmos.getFont("courier", 14))
+      end
+    end
+
+    def format_value(data)
+      text = ""
+      space = ' '
+      new_line = "\n"
+
+      byte_count = 0
+      addr       = 0
+      data.each_byte do |value|
+        if @addr_format and byte_count == 0
+          text << sprintf(@addr_format, addr)
+          addr += @bytes_per_row
+        end
+        text << sprintf(@format_string, value)
+        byte_count += 1
+        if (byte_count % @bytes_per_row) == 0
+          byte_count = 0
+          text << new_line
+        elsif (byte_count % @bytes_per_word) == 0
+          text << space
+        end
+      end
+      text
+    end
+  end
+
+end # module Cosmos

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

@@ -0,0 +1,39 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+# This file contains the implementation of the ButtonWidget class.
+
+require 'cosmos'
+require 'cosmos/tools/tlm_viewer/widgets/widget'
+require 'cosmos/gui/utilities/script_module_gui'
+
+module Cosmos
+
+  class ButtonWidget < Qt::PushButton
+    include Widget
+
+    def initialize (parent_layout, button_text, string_to_eval)
+      super()
+      setText(button_text.to_s)
+      connect(SIGNAL('clicked()')) do
+        begin
+          @screen.instance_eval(string_to_eval.to_s)
+        rescue DRb::DRbConnError
+          Qt::MessageBox.warning(parent.parentWidget, 'Error', "Error Connecting to Command and Telemetry Server")
+        rescue Exception => error
+          Qt::MessageBox.warning(parent.parentWidget, 'Error', "#{error.class} : #{error.message}")
+        end
+      end
+      parent_layout.addWidget(self) if parent_layout
+    end
+
+  end
+
+end # module Cosmos

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

@@ -0,0 +1,62 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+# This file contains the implementation of the CanvasWidget class.   This widget
+# represents a canvas where draw-able widgets (such as images and lines) can be
+# added.
+
+require 'cosmos'
+require 'cosmos/tools/tlm_viewer/widgets/widget'
+require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
+
+module Cosmos
+
+  class CanvasWidget < Qt::Widget
+    include Widget
+    include LayoutWidget
+
+    def initialize(parent_layout, width, height)
+      super()
+      @repaintObjects = []
+      self.minimumWidth = width.to_i
+      self.minimumHeight = height.to_i
+      parent_layout.addWidget(self) if parent_layout
+    end
+
+    # add_repaint - Child widgets to the canvas must call add_repaint to register
+    # itself with the canvas so that they are painted when the canvas is.  Note,
+    # the order in which child widgets are painted is the order in which they
+    # are created.
+    def add_repaint(obj)
+      @repaintObjects << obj
+    end
+
+    def paintEvent(event)
+      begin
+        painter = Qt::Painter.new
+        painter.begin(self)
+        painter.setBackgroundMode(Qt::OpaqueMode)
+        painter.setBackground(Cosmos.getBrush(Qt::white))
+        @repaintObjects.each do |obj|
+          obj.paint(painter)
+        end
+        painter.end
+        painter.dispose
+      rescue Exception => err
+        Cosmos.handle_fatal_exception(err)
+      end
+    end
+
+    def update_widget
+      self.update
+    end
+  end
+
+end # module Cosmos

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

@@ -0,0 +1,41 @@
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos/tools/tlm_viewer/widgets/widget'
+
+module Cosmos
+
+  class CanvasimageWidget
+    include Widget
+
+    def initialize(parent_layout, filename, x, y)
+      super()
+      @x = x.to_i
+      @y = y.to_i
+      @image = nil
+      filename = File.join(::Cosmos::USERPATH, 'config', 'data', filename)
+      unless File.exist?(filename)
+        raise "Can't find the file #{filename} in #{::Cosmos::USERPATH}/config/data"
+      end
+      @image = Qt::Image.new(filename)
+      parent_layout.add_repaint(self)
+    end
+
+    def paint(painter)
+      painter.drawImage(@x, @y, @image) if @image
+    end
+
+    def dispose
+      super()
+      @image.dispose
+    end
+  end
+
+end # module Cosmos