cosmos 4.3.0 → 4.4.0

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

@@ -21,6 +21,7 @@ require 'cosmos/tools/tlm_viewer/widgets/horizontal_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/horizontalbox_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/horizontalline_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/labelformatvalue_widget.rb'
+require 'cosmos/tools/tlm_viewer/widgets/labelled_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/labelprogressbar_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/labeltrendlimitsbar_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/labelvaluedesc_widget.rb'
@@ -31,6 +32,7 @@ require 'cosmos/tools/tlm_viewer/widgets/labelvaluerangecolumn_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/labelvalue_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/label_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget.rb'
+require 'cosmos/tools/tlm_viewer/widgets/led_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/limitsbar_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/limitscolumn_widget.rb'
 require 'cosmos/tools/tlm_viewer/widgets/limitscolor_widget.rb'

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

@@ -11,9 +11,10 @@
 require 'cosmos'
 
 module Cosmos
-
+  # Implement aging in a telemetry widget. When values change they are
+  # displayed whith a white background. If the value doesn't change the
+  # text box background slowly fades to grey.
   module AgingWidget
-
     attr_accessor :coloring
 
     def setup_aging
@@ -104,7 +105,5 @@ module Cosmos
         end
       end
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -13,7 +13,8 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/aging_widget'
 
 module Cosmos
-
+  # Displays an array of values in a text box. The values can be formatted
+  # and displayed in multiple rows.
   class ArrayWidget < Qt::TextEdit
     include Widget
     include AgingWidget
@@ -60,7 +61,5 @@ module Cosmos
       super
       process_aging_settings
     end
-
   end
-
-end # module Cosmos
+end

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

@@ -15,10 +15,10 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/textbox_widget'
 
 module Cosmos
-
+  # Displays binary data in a large scrollable window with the data address
+  # (offset into the data) followed by the binary data.
   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)
+    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
@@ -53,5 +53,4 @@ module Cosmos
       text
     end
   end
-
-end # module Cosmos
+end

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

@@ -9,18 +9,32 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
+  # Creates a clickable point on the canvas which opens another screen.
+  # Add to canvas by using the SCREEN setting. For example:
+  #   SETTING SCREEN "INST HS" 100 100
   module CanvasClickable
     # Requires @x, @y, @x_end, and @y_end to be defined
     def on_click(event, x, y)
       return false unless @screen_settings
       if (x < @x_end) && (x > @x) && (y < @y_end) && (y > @y)
         display(@screen_settings[0], @screen_settings[1].to_i, @screen_settings[2].to_i)
-        true
+        true # We handled the click so return true
       else
-        false
+        false # Allow other widgets to handle the on_click
       end
     end
 
+    # Requires @x, @y, @x_end, and @y_end to be defined
+    def on_move(event, x, y)
+      return false unless @screen_settings
+      if (x < @x_end) && (x > @x) && (y < @y_end) && (y > @y)
+        Qt::Application.setOverrideCursor(Cosmos.getCursor(Qt::PointingHandCursor))
+      else
+        Qt::Application.setOverrideCursor(Cosmos.getCursor(Qt::ArrowCursor))
+      end
+      false # Allow other widgets to handle on_move
+    end
+
     def set_setting(setting_name, setting_values)
       case setting_name.upcase
       when 'SCREEN'

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

@@ -8,7 +8,7 @@
 # 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
+# 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.
 
@@ -17,20 +17,24 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/layout_widget'
 
 module Cosmos
+  # Create a blank widget which other widgets can draw on using the painter.
+  # Each subwidget should implement the paint(painter) method which will be
+  # called in the paintEvent of this widget.
   class CanvasWidget < Qt::Widget
     include Widget
     include LayoutWidget
 
     def initialize(parent_layout, width, height)
       super()
+      setMouseTracking(true) # for mouse move events
       @repaint_objects = []
       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,
+    # 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)
@@ -63,6 +67,16 @@ module Cosmos
       end
     end
 
+    def mouseMoveEvent(event)
+      cur_x = mapFromGlobal(self.cursor.pos).x
+      cur_y = mapFromGlobal(self.cursor.pos).y
+      @repaint_objects.each do |obj|
+        if obj.respond_to?(:on_move)
+          break if obj.on_move(event, cur_x, cur_y)
+        end
+      end
+    end
+
     def update_widget
       self.update
     end

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

@@ -11,6 +11,7 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
+  # Display a circle on the canvas of specified color and width
   class CanvasdotWidget
     include Widget
 
@@ -29,8 +30,6 @@ module Cosmos
       end
 
       @point = Qt::Point.new(0, 0)
-      update_point
-
       @width = width.to_i
       @color = Cosmos::getColor(color)
       parent_layout.add_repaint(self)

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

@@ -11,6 +11,7 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
+  # Display an ellipse on the canvas which can be filled or open
   class CanvasellipseWidget
     include Widget
 
@@ -35,6 +36,5 @@ module Cosmos
       painter.drawEllipse(@center_x, @center_y, @width, @height)
       painter.restore
     end
-
   end
 end

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

@@ -12,6 +12,8 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/canvas_clickable'
 
 module Cosmos
+  # Displays an image on a canvas. The image is loaded from file first by
+  # looking in the target's screens directory and then the COSMOS data path.
   class CanvasimageWidget
     include Widget
     include CanvasClickable
@@ -20,15 +22,9 @@ module Cosmos
       super()
       @x = x.to_i
       @y = y.to_i
+      @filename = filename
       @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)
-      @x_end = @x + @image.width
-      @y_end = @y + @image.height
     end
 
     def paint(painter)
@@ -39,5 +35,14 @@ module Cosmos
       super()
       @image.dispose
     end
+
+    def process_settings
+      super
+      # We wait until here to find the image because we need @screen to be set
+      # to determine the target name to look in the target's screens directory
+      @image = get_image(@filename)
+      @x_end = @x + @image.width
+      @y_end = @y + @image.height
+    end
   end
 end

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

@@ -8,52 +8,102 @@
 # 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 CanvasimagevalueWidget class.  This
-# widget displays one of two images within a CanvasWidget.  The image displayed
-# is either '[filename]on.gif' or '[filename]off.gif' depending on the
-# telemetry point value of 1 or 0 respectively.
+# This file contains the implementation of the CanvasimagevalueWidget class.
+# The widget displays a default image but users should use the SETTING IMAGE
+# option to set the images to display for a given value.
 
 require 'cosmos/tools/tlm_viewer/widgets/canvasvalue_widget'
 require 'cosmos/tools/tlm_viewer/widgets/canvas_clickable'
 
 module Cosmos
+  # Displays an image on a canvas based on a telemetry value. Multiple images
+  # can be set to display by using the IMAGE setting. For example:
+  #   CANVASIMAGEVALUE TGT PKT ITEM CONVERTED "ground_error.gif" 400 100
+  #   SETTING IMAGE CONNECTED "ground_on.gif" 400 100
+  #   SETTING IMAGE UNAVAILABLE "ground_off.gif" 400 100
+  # The default image to display is error.gif. If the converted value from
+  # the telemetry point named TGT PKT ITEM has a converted value of
+  # 'CONNECTED' the ground_on.gif image is displayed and if the value is
+  # 'UNAVAILABLE' the ground_off.git image is displayed.
   class CanvasimagevalueWidget < CanvasvalueWidget
     include CanvasClickable
-    
-    def initialize(parent_layout, target_name, packet_name, item_name, filename, x, y, value_type = :RAW)
-      super(parent_layout, target_name, packet_name, item_name, value_type)
-      @x = x.to_i
-      @y = y.to_i
-      @image_on = nil
-      @image_off = nil
-
-      filenameOn = Dir[File.join(::Cosmos::USERPATH, 'config', 'data', filename + 'on.*')][0]
-      unless File.exist?(filenameOn)
-        raise "Can't find the file #{filenameOn} in #{::Cosmos::USERPATH}/config/data"
-      end
-      @image_on = Qt::Image.new(filenameOn)
 
-      filenameOff = Dir[File.join(::Cosmos::USERPATH, 'config', 'data', filename + 'off.*')][0]
-      unless File.exist?(filenameOff)
-        raise "Can't find the file #{filenameOff} in #{::Cosmos::USERPATH}/config/data"
+    def initialize(parent_layout, target_name, packet_name, item_name, value_type = :RAW, default_image = nil, x = nil, y = nil)
+      super(parent_layout, target_name, packet_name, item_name, value_type)
+      @images = []
+      if default_image
+        @default_image_name = default_image
+        @default_x = Integer(x)
+        @default_y = Integer(y)
       end
-      @image_off = Qt::Image.new(filenameOff)
-      @x_end = @x + [@image_on.width, @image_off.width].max
-      @y_end = @y + [@image_on.height, @image_off.height].max
     end
 
-    def draw_widget(painter, on_value)
-      if on_value
-        painter.drawImage(@x, @y, @image_on) if @image_on
+    def paint(painter)
+      if @values.length > 1
+        eval_string = "1"
+        # This code uses the booleans set by the process_settings function and evaluates it to logically determine
+        # if the item should be drawn on the canvas as "on" or "off".
+        @item_settings.each_with_index do |item, index|
+          next if @values[index].to_f.nan? || @values[index].to_f.infinite?
+          eval_string << " " << item[0].to_s << " (" << @values[index].to_s << " " << item[1].to_s << " " << item[2].to_s << ")"
+        end
+        @value = eval(eval_string)
       else
-        painter.drawImage(@x, @y, @image_off) if @image_off
+        @value = @values[0]
       end
+      eval(@eval)
     end
 
     def dispose
       super()
-      @image_on.dispose
-      @image_off.dispose
+      @images.each {|image| image.dispose }
+      @default_image.dispose if @default_image
+    end
+
+    def set_setting(setting_name, setting_values)
+      # Allow for multiple IMAGE settings by deconflicting the hash key by appending the value
+      if setting_name.upcase == 'IMAGE'
+        @settings["#{setting_name.to_s.upcase}_#{setting_values[0]}"] = setting_values
+      else
+        super(setting_name, setting_values)
+      end
+    end
+
+    def process_settings
+      super
+      @eval = 'case @value;'
+      @settings.each do |setting_name, setting_values|
+        case setting_name
+        when /IMAGE/
+          value_string = setting_values[0]
+          @images << get_image(setting_values[1])
+          x = setting_values[2]
+          y = setting_values[3]
+
+          case value_string.upcase
+          when 'TRUE'
+            value = true
+          when 'FALSE'
+            value = false
+          when /\d\.\.\d/ # Range
+            value = Range.new(*value_string.split("..").map(&:to_i))
+          else
+            begin
+              value = Float(value_string)
+            rescue
+              value = "'#{value_string}'"
+            end
+          end
+          @eval << "when #{value} then painter.drawImage(#{x}, #{y}, @images[#{@images.length-1}]);"
+          @eval << "@x=#{x};@y=#{y};@x_end=@x+@images[#{@images.length-1}].width;@y_end=@y+@images[#{@images.length-1}].height;"
+        end
+      end
+      if @default_image_name
+        @default_image = get_image(@default_image_name)
+        @eval << "else painter.drawImage(@default_x, @default_y, @default_image);"
+        @eval << "@x=@default_x;@y=@default_y;@x_end=@x+@default_image.width;@y_end=@y+@default_image.height;"
+      end
+      @eval << "end"
     end
   end
 end

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

@@ -12,6 +12,7 @@ require 'cosmos/tools/tlm_viewer/widgets/widget'
 require 'cosmos/tools/tlm_viewer/widgets/canvas_clickable'
 
 module Cosmos
+  # Display text on the canvas of a given size and color
   class CanvaslabelWidget
     include Widget
     include CanvasClickable

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

@@ -12,7 +12,8 @@ require 'cosmos'
 require 'cosmos/tools/tlm_viewer/widgets/canvasvalue_widget'
 
 module Cosmos
-
+  # Displays a label and value for the given telemetry point. By default
+  # the telemetry value is drawn inside a rectangular box.
   class CanvaslabelvalueWidget < CanvasvalueWidget
     def initialize(parent_layout, target_name, packet_name, item_name, x1, y1, font_size = 12, color = 'black', frame = true, frame_width = 3, value_type = :CONVERTED)
       super(parent_layout, target_name, packet_name, item_name, value_type)

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

@@ -11,6 +11,8 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
+  # Draws a line on the canvas with an optional 'connector' (circle) on
+  # the end of the line
   class CanvaslineWidget
     include Widget
 

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

@@ -15,6 +15,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/canvasvalue_widget'
 
 module Cosmos
+  # Draws a line on the canvas that changes color based on the value of the
+  # given telemetry point. Typically used to either show to hide the line
+  # by drawing it as the same color as the canvas. For example:
+  #   CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 420 135 240 330 green white 3
   class CanvaslinevalueWidget < CanvasvalueWidget
     def initialize(parent_layout, target_name, packet_name, item_name, x1, y1, x2, y2, color_on = 'green', color_off = 'blue', width = 3, connector = 'NO_CONNECTOR', value_type = :RAW)
       super(parent_layout, target_name, packet_name, item_name, value_type)

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

@@ -11,6 +11,10 @@
 require 'cosmos/tools/tlm_viewer/widgets/widget'
 
 module Cosmos
+  # Abstract class which provides helper methods to draw a telemetry point
+  # on a canvas. Has the ability to AND or OR together additional telemetry
+  # points to determine whether the value is "on" or not. Subclasses must
+  # implement draw_widget(draw_context, on_state).
   class CanvasvalueWidget
     include Widget
 
@@ -68,34 +72,38 @@ module Cosmos
       raise 'Override draw_widget to make this class work!'
     end
 
+    def set_setting(setting_name, setting_values)
+      if setting_name =~ /^TLM_/
+        @settings["#{setting_name.to_s.upcase}_#{setting_values.join('_')}"] = setting_values
+      else
+        super(setting_name, setting_values)
+      end
+    end
+
     def process_settings
       super
       @settings.each do |setting_name, setting_values|
-        begin
-          case setting_name
-          when 'VALUE_EQ'
-            @item_settings[0] = ['and', '==', setting_values[0]]
-          when 'VALUE_GT'
-            @item_settings[0] = ['and', '>', setting_values[0]]
-          when 'VALUE_GTEQ'
-            @item_settings[0] = ['and', '>=', setting_values[0]]
-          when 'VALUE_LT'
-            @item_settings[0] = ['and', '<', setting_values[0]]
-          when 'VALUE_LTEQ'
-            @item_settings[0] = ['and', '<=', setting_values[0]]
-          # TLM_AND allows a telemetry item to be dependant on another item for its state
-          when 'TLM_AND'
-            @items << [setting_values[0], setting_values[1], setting_values[2]]
-            @values << 0
-            set_item_settings('and', setting_values[3], setting_values[4])
-          # TLM_OR allows a telemetry item to be dependant on another item for its state
-          when 'TLM_OR'
-            @items << [setting_values[0], setting_values[1], setting_values[2]]
-            @values << 0
-            set_item_settings('or', setting_values[3], setting_values[4])
-          end
-        rescue => err
-          puts "Error Processing Settings!: #{err}"
+        case setting_name
+        when 'VALUE_EQ'
+          @item_settings[0] = ['and', '==', setting_values[0]]
+        when 'VALUE_GT'
+          @item_settings[0] = ['and', '>', setting_values[0]]
+        when 'VALUE_GTEQ'
+          @item_settings[0] = ['and', '>=', setting_values[0]]
+        when 'VALUE_LT'
+          @item_settings[0] = ['and', '<', setting_values[0]]
+        when 'VALUE_LTEQ'
+          @item_settings[0] = ['and', '<=', setting_values[0]]
+        # TLM_AND allows a telemetry item to be dependant on another item for its state
+        when /^TLM_AND/
+          @items << [setting_values[0], setting_values[1], setting_values[2]]
+          @values << 0
+          set_item_settings('and', setting_values[3], setting_values[4])
+        # TLM_OR allows a telemetry item to be dependant on another item for its state
+        when /^TLM_OR/
+          @items << [setting_values[0], setting_values[1], setting_values[2]]
+          @values << 0
+          set_item_settings('or', setting_values[3], setting_values[4])
         end
       end
     end