cosmos 3.5.1 → 3.5.2

data/lib/cosmos/script/telemetry.rb

@@ -1,174 +1,174 @@
-# 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
-
-module Cosmos
-
-  module Script
-    private
-
-    # Poll for the converted value of a telemetry item
-    # Usage:
-    #   tlm(target_name, packet_name, item_name)
-    # or
-    #   tlm('target_name packet_name item_name')
-    def tlm(*args)
-      return $cmd_tlm_server.tlm(*args)
-    end
-
-    # Poll for the raw value of a telemetry item
-    # Usage:
-    #   tlm_raw(target_name, packet_name, item_name)
-    # or
-    #   tlm_raw('target_name packet_name item_name')
-    def tlm_raw(*args)
-      return $cmd_tlm_server.tlm_raw(*args)
-    end
-
-    # Poll for the formatted value of a telemetry item
-    # Usage:
-    #   tlm_formatted(target_name, packet_name, item_name)
-    # or
-    #   tlm_formatted('target_name packet_name item_name')
-    def tlm_formatted(*args)
-      return $cmd_tlm_server.tlm_formatted(*args)
-    end
-
-    # Poll for the formatted with units value of a telemetry item
-    # Usage:
-    #   tlm_with_units(target_name, packet_name, item_name)
-    # or
-    #   tlm_with_units('target_name packet_name item_name')
-    def tlm_with_units(*args)
-      return $cmd_tlm_server.tlm_with_units(*args)
-    end
-
-    def tlm_variable(*args)
-      return $cmd_tlm_server.tlm_variable(*args)
-    end
-
-    # Set a telemetry point to a given value. Note this will be over written in
-    # a live system by incoming new telemetry.
-    # Usage:
-    #   set_tlm(target_name, packet_name, item_name, value)
-    # or
-    #   set_tlm("target_name packet_name item_name = value")
-    def set_tlm(*args)
-      return $cmd_tlm_server.set_tlm(*args)
-    end
-
-    # Set the raw value of a telemetry point to a given value. Note this will
-    # be over written in a live system by incoming new telemetry.
-    # Usage:
-    #   set_tlm(target_name, packet_name, item_name, value)
-    # or
-    #   set_tlm("target_name packet_name item_name = value")
-    def set_tlm_raw(*args)
-      return $cmd_tlm_server.set_tlm_raw(*args)
-    end
-
-    # Gets all the values from the given packet returned in a two dimensional
-    # array containing the item_name, value, and limits state.
-    # Usage:
-    #   values = get_tlm_packet(target_name, packet_name, <:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS>)
-    def get_tlm_packet(target_name, packet_name, value_types = :CONVERTED)
-      result = $cmd_tlm_server.get_tlm_packet(target_name, packet_name, value_types)
-      result.each do |entry|
-        entry[2] = entry[2].to_s.intern if entry[2]
-      end
-      result
-    end
-
-    # Gets all the values from the given packet returned in an
-    # array consisting of an Array of item values, an array of item limits state
-    # given as symbols such as :RED, :YELLOW, :STALE, an array of arrays including
-    # the limits setting such as red low, yellow low, yellow high, red high and
-    # optionally green low and high, and the overall limits state of the system.
-    # Usage:
-    #   values = get_tlm_values([[target_name, packet_name, item_name], ...], <:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS>)
-    def get_tlm_values(items, value_types = :CONVERTED)
-      result = $cmd_tlm_server.get_tlm_values(items, value_types)
-      result[1].length.times do |index|
-        result[1][index] = result[1][index].to_s.intern if result[1][index]
-      end
-      result[3] = result[3].to_s.intern
-      result
-    end
-
-    # Gets the packets for a given target name. Returns an array of arrays
-    # consisting of packet names and packet descriptions.
-    def get_tlm_list(target_name)
-      return $cmd_tlm_server.get_tlm_list(target_name)
-    end
-
-    # Gets all the telemetry mnemonics for a given target and packet. Returns an
-    # array of arrays consisting of item names, item states, and item descriptions.
-    def get_tlm_item_list(target_name, packet_name)
-      return $cmd_tlm_server.get_tlm_item_list(target_name, packet_name)
-    end
-
-    # Gets the list of all defined targets.
-    def get_target_list
-      return $cmd_tlm_server.get_target_list
-    end
-
-    def get_tlm_details(items)
-      $cmd_tlm_server.get_tlm_details(items)
-    end
-
-    # Subscribe to one or more telemetry packets. The queue ID is returned for
-    # use in get_packet_data and unsubscribe_packet_data.
-    # Usage:
-    #   id = subscribe_packet_data([[target_name,packet_name], ...], <queue_size>)
-    def subscribe_packet_data(packets, queue_size = CmdTlmServer::DEFAULT_PACKET_DATA_QUEUE_SIZE)
-      result = $cmd_tlm_server.subscribe_packet_data(packets, queue_size)
-      result
-    end
-
-    # Unsubscribe to telemetry packets. Pass the queue ID which was returned by
-    # the subscribe_packet_data method.
-    # Usage:
-    #   unsubscribe_packet_data(id)
-    def unsubscribe_packet_data(id)
-      result = $cmd_tlm_server.unsubscribe_packet_data(id)
-      result
-    end
-
-    # DEPRECATED
-    def get_packet_data(id, non_block = false)
-      results = $cmd_tlm_server.get_packet_data(id, non_block)
-      if Array === results and results[3] and results[4]
-        results[3] = Time.at(results[3], results[4])
-        results.delete_at(4)
-      end
-      results
-    end
-
-    # Get a packet which was previously subscribed to by
-    # subscribe_packet_data. This method can block waiting for new packets or
-    # not based on the second parameter. It returns a single Cosmos::Packet instance
-    # and will return nil when no more packets are buffered (assuming non_block
-    # is false).
-    # Usage:
-    #   get_packet(id, <true or false to block>)
-    def get_packet(id, non_block = false)
-      packet = nil
-      buffer, target_name, packet_name, received_time, received_count = get_packet_data(id, non_block)
-      if buffer
-        packet = System.telemetry.packet(target_name, packet_name).clone
-        packet.buffer = buffer
-        packet.received_time = received_time
-        packet.received_count = received_count
-      end
-      packet
-    end
-
-  end
-end
-
+# 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
+
+module Cosmos
+
+  module Script
+    private
+
+    # Poll for the converted value of a telemetry item
+    # Usage:
+    #   tlm(target_name, packet_name, item_name)
+    # or
+    #   tlm('target_name packet_name item_name')
+    def tlm(*args)
+      return $cmd_tlm_server.tlm(*args)
+    end
+
+    # Poll for the raw value of a telemetry item
+    # Usage:
+    #   tlm_raw(target_name, packet_name, item_name)
+    # or
+    #   tlm_raw('target_name packet_name item_name')
+    def tlm_raw(*args)
+      return $cmd_tlm_server.tlm_raw(*args)
+    end
+
+    # Poll for the formatted value of a telemetry item
+    # Usage:
+    #   tlm_formatted(target_name, packet_name, item_name)
+    # or
+    #   tlm_formatted('target_name packet_name item_name')
+    def tlm_formatted(*args)
+      return $cmd_tlm_server.tlm_formatted(*args)
+    end
+
+    # Poll for the formatted with units value of a telemetry item
+    # Usage:
+    #   tlm_with_units(target_name, packet_name, item_name)
+    # or
+    #   tlm_with_units('target_name packet_name item_name')
+    def tlm_with_units(*args)
+      return $cmd_tlm_server.tlm_with_units(*args)
+    end
+
+    def tlm_variable(*args)
+      return $cmd_tlm_server.tlm_variable(*args)
+    end
+
+    # Set a telemetry point to a given value. Note this will be over written in
+    # a live system by incoming new telemetry.
+    # Usage:
+    #   set_tlm(target_name, packet_name, item_name, value)
+    # or
+    #   set_tlm("target_name packet_name item_name = value")
+    def set_tlm(*args)
+      return $cmd_tlm_server.set_tlm(*args)
+    end
+
+    # Set the raw value of a telemetry point to a given value. Note this will
+    # be over written in a live system by incoming new telemetry.
+    # Usage:
+    #   set_tlm(target_name, packet_name, item_name, value)
+    # or
+    #   set_tlm("target_name packet_name item_name = value")
+    def set_tlm_raw(*args)
+      return $cmd_tlm_server.set_tlm_raw(*args)
+    end
+
+    # Gets all the values from the given packet returned in a two dimensional
+    # array containing the item_name, value, and limits state.
+    # Usage:
+    #   values = get_tlm_packet(target_name, packet_name, <:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS>)
+    def get_tlm_packet(target_name, packet_name, value_types = :CONVERTED)
+      result = $cmd_tlm_server.get_tlm_packet(target_name, packet_name, value_types)
+      result.each do |entry|
+        entry[2] = entry[2].to_s.intern if entry[2]
+      end
+      result
+    end
+
+    # Gets all the values from the given packet returned in an
+    # array consisting of an Array of item values, an array of item limits state
+    # given as symbols such as :RED, :YELLOW, :STALE, an array of arrays including
+    # the limits setting such as red low, yellow low, yellow high, red high and
+    # optionally green low and high, and the overall limits state of the system.
+    # Usage:
+    #   values = get_tlm_values([[target_name, packet_name, item_name], ...], <:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS>)
+    def get_tlm_values(items, value_types = :CONVERTED)
+      result = $cmd_tlm_server.get_tlm_values(items, value_types)
+      result[1].length.times do |index|
+        result[1][index] = result[1][index].to_s.intern if result[1][index]
+      end
+      result[3] = result[3].to_s.intern
+      result
+    end
+
+    # Gets the packets for a given target name. Returns an array of arrays
+    # consisting of packet names and packet descriptions.
+    def get_tlm_list(target_name)
+      return $cmd_tlm_server.get_tlm_list(target_name)
+    end
+
+    # Gets all the telemetry mnemonics for a given target and packet. Returns an
+    # array of arrays consisting of item names, item states, and item descriptions.
+    def get_tlm_item_list(target_name, packet_name)
+      return $cmd_tlm_server.get_tlm_item_list(target_name, packet_name)
+    end
+
+    # Gets the list of all defined targets.
+    def get_target_list
+      return $cmd_tlm_server.get_target_list
+    end
+
+    def get_tlm_details(items)
+      $cmd_tlm_server.get_tlm_details(items)
+    end
+
+    # Subscribe to one or more telemetry packets. The queue ID is returned for
+    # use in get_packet_data and unsubscribe_packet_data.
+    # Usage:
+    #   id = subscribe_packet_data([[target_name,packet_name], ...], <queue_size>)
+    def subscribe_packet_data(packets, queue_size = CmdTlmServer::DEFAULT_PACKET_DATA_QUEUE_SIZE)
+      result = $cmd_tlm_server.subscribe_packet_data(packets, queue_size)
+      result
+    end
+
+    # Unsubscribe to telemetry packets. Pass the queue ID which was returned by
+    # the subscribe_packet_data method.
+    # Usage:
+    #   unsubscribe_packet_data(id)
+    def unsubscribe_packet_data(id)
+      result = $cmd_tlm_server.unsubscribe_packet_data(id)
+      result
+    end
+
+    # DEPRECATED
+    def get_packet_data(id, non_block = false)
+      results = $cmd_tlm_server.get_packet_data(id, non_block)
+      if Array === results and results[3] and results[4]
+        results[3] = Time.at(results[3], results[4])
+        results.delete_at(4)
+      end
+      results
+    end
+
+    # Get a packet which was previously subscribed to by
+    # subscribe_packet_data. This method can block waiting for new packets or
+    # not based on the second parameter. It returns a single Cosmos::Packet instance
+    # and will return nil when no more packets are buffered (assuming non_block
+    # is false).
+    # Usage:
+    #   get_packet(id, <true or false to block>)
+    def get_packet(id, non_block = false)
+      packet = nil
+      buffer, target_name, packet_name, received_time, received_count = get_packet_data(id, non_block)
+      if buffer
+        packet = System.telemetry.packet(target_name, packet_name).clone
+        packet.buffer = buffer
+        packet.received_time = received_time
+        packet.received_count = received_count
+      end
+      packet
+    end
+
+  end
+end
+

data/lib/cosmos/script/tools.rb

@@ -1,138 +1,138 @@
-# 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
-
-module Cosmos
-
-  module Script
-    private
-
-    #######################################
-    # Methods accessing tlm_viewer
-    #######################################
-
-    def display(display_name, x_pos = nil, y_pos = nil)
-      run_tlm_viewer(display_name, "displayed") do |tlm_viewer|
-        tlm_viewer.display(display_name, x_pos, y_pos)
-      end
-    end
-
-    def clear(display_name)
-      run_tlm_viewer(display_name, "cleared") do |tlm_viewer|
-        tlm_viewer.clear(display_name)
-      end
-    end
-
-    def run_tlm_viewer(display_name, action)
-      tlm_viewer = JsonDRbObject.new "localhost", System.ports['TLMVIEWER_API']
-      begin
-        yield tlm_viewer
-        tlm_viewer.disconnect
-      rescue DRb::DRbConnError
-        # No Listening Tlm Viewer - So Start One
-        start_tlm_viewer
-        begin
-          yield tlm_viewer
-          tlm_viewer.disconnect
-        rescue DRb::DRbConnError
-          raise "Unable to Successfully Start Listening Telemetry Viewer: #{display_name} could not be #{action}"
-        rescue Errno::ENOENT
-          raise "Display Screen File: #{display_name}.txt does not exist"
-        end
-      rescue Errno::ENOENT
-        raise "Display Screen File: #{display_name}.txt does not exist"
-      end
-    end
-
-    def start_tlm_viewer
-      system_file = File.basename(System.initial_filename)
-      mac_app = File.join(Cosmos::USERPATH, 'tools', 'mac', 'TlmViewer.app')
-
-      if Kernel.is_mac? && File.exist?(mac_app)
-        Cosmos.run_process("open '#{mac_app}' --args --system #{system_file}")
-      else
-        cmd = 'ruby'
-        cmd << 'w' if Kernel.is_windows? # Windows uses rubyw to avoid creating a DOS shell
-        Cosmos.run_process("#{cmd} '#{File.join(Cosmos::USERPATH, 'tools', 'TlmViewer')}' --system #{system_file}")
-      end
-      sleep(5)
-    end
-
-    #######################################
-    # Methods accessing script runner
-    #######################################
-
-    def _ensure_script_runner_frame
-      yield if defined? ScriptRunnerFrame && ScriptRunnerFrame.instance
-    end
-
-    def set_line_delay(delay)
-      _ensure_script_runner_frame { ScriptRunnerFrame.line_delay = delay if delay >= 0.0 }
-    end
-
-    def get_line_delay
-      _ensure_script_runner_frame { ScriptRunnerFrame.line_delay }
-    end
-
-    def get_scriptrunner_message_log_filename
-      filename = nil
-      _ensure_script_runner_frame do
-        filename = ScriptRunnerFrame.instance.message_log.filename if ScriptRunnerFrame.instance.message_log
-      end
-      return filename
-    end
-
-    def start_new_scriptrunner_message_log
-      # A new log will be created at the next message
-      _ensure_script_runner_frame { ScriptRunnerFrame.instance.stop_message_log }
-    end
-
-    def disable_instrumentation
-      if defined? ScriptRunnerFrame && ScriptRunnerFrame.instance
-        ScriptRunnerFrame.instance.use_instrumentation = false
-        begin
-          yield
-        ensure
-          ScriptRunnerFrame.instance.use_instrumentation = true
-        end
-      else
-        yield
-      end
-    end
-
-    def set_stdout_max_lines(max_lines)
-      _ensure_script_runner_frame { ScriptRunnerFrame.instance.stdout_max_lines = max_lines }
-    end
-
-    #######################################
-    # 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
-      _ensure_script_runner_frame { ScriptRunnerFrame.step_mode = true }
-    end
-
-    def run_mode
-      _ensure_script_runner_frame { ScriptRunnerFrame.step_mode = false }
-    end
-
-    def show_backtrace(value = true)
-      _ensure_script_runner_frame { ScriptRunnerFrame.show_backtrace = value }
-    end
-
-  end # module Script
-
-end # module Cosmos
+# 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
+
+module Cosmos
+
+  module Script
+    private
+
+    #######################################
+    # Methods accessing tlm_viewer
+    #######################################
+
+    def display(display_name, x_pos = nil, y_pos = nil)
+      run_tlm_viewer(display_name, "displayed") do |tlm_viewer|
+        tlm_viewer.display(display_name, x_pos, y_pos)
+      end
+    end
+
+    def clear(display_name)
+      run_tlm_viewer(display_name, "cleared") do |tlm_viewer|
+        tlm_viewer.clear(display_name)
+      end
+    end
+
+    def run_tlm_viewer(display_name, action)
+      tlm_viewer = JsonDRbObject.new "localhost", System.ports['TLMVIEWER_API']
+      begin
+        yield tlm_viewer
+        tlm_viewer.disconnect
+      rescue DRb::DRbConnError
+        # No Listening Tlm Viewer - So Start One
+        start_tlm_viewer
+        begin
+          yield tlm_viewer
+          tlm_viewer.disconnect
+        rescue DRb::DRbConnError
+          raise "Unable to Successfully Start Listening Telemetry Viewer: #{display_name} could not be #{action}"
+        rescue Errno::ENOENT
+          raise "Display Screen File: #{display_name}.txt does not exist"
+        end
+      rescue Errno::ENOENT
+        raise "Display Screen File: #{display_name}.txt does not exist"
+      end
+    end
+
+    def start_tlm_viewer
+      system_file = File.basename(System.initial_filename)
+      mac_app = File.join(Cosmos::USERPATH, 'tools', 'mac', 'TlmViewer.app')
+
+      if Kernel.is_mac? && File.exist?(mac_app)
+        Cosmos.run_process("open '#{mac_app}' --args --system #{system_file}")
+      else
+        cmd = 'ruby'
+        cmd << 'w' if Kernel.is_windows? # Windows uses rubyw to avoid creating a DOS shell
+        Cosmos.run_process("#{cmd} '#{File.join(Cosmos::USERPATH, 'tools', 'TlmViewer')}' --system #{system_file}")
+      end
+      sleep(5)
+    end
+
+    #######################################
+    # Methods accessing script runner
+    #######################################
+
+    def _ensure_script_runner_frame
+      yield if defined? ScriptRunnerFrame && ScriptRunnerFrame.instance
+    end
+
+    def set_line_delay(delay)
+      _ensure_script_runner_frame { ScriptRunnerFrame.line_delay = delay if delay >= 0.0 }
+    end
+
+    def get_line_delay
+      _ensure_script_runner_frame { ScriptRunnerFrame.line_delay }
+    end
+
+    def get_scriptrunner_message_log_filename
+      filename = nil
+      _ensure_script_runner_frame do
+        filename = ScriptRunnerFrame.instance.message_log.filename if ScriptRunnerFrame.instance.message_log
+      end
+      return filename
+    end
+
+    def start_new_scriptrunner_message_log
+      # A new log will be created at the next message
+      _ensure_script_runner_frame { ScriptRunnerFrame.instance.stop_message_log }
+    end
+
+    def disable_instrumentation
+      if defined? ScriptRunnerFrame && ScriptRunnerFrame.instance
+        ScriptRunnerFrame.instance.use_instrumentation = false
+        begin
+          yield
+        ensure
+          ScriptRunnerFrame.instance.use_instrumentation = true
+        end
+      else
+        yield
+      end
+    end
+
+    def set_stdout_max_lines(max_lines)
+      _ensure_script_runner_frame { ScriptRunnerFrame.instance.stdout_max_lines = max_lines }
+    end
+
+    #######################################
+    # 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
+      _ensure_script_runner_frame { ScriptRunnerFrame.step_mode = true }
+    end
+
+    def run_mode
+      _ensure_script_runner_frame { ScriptRunnerFrame.step_mode = false }
+    end
+
+    def show_backtrace(value = true)
+      _ensure_script_runner_frame { ScriptRunnerFrame.show_backtrace = value }
+    end
+
+  end # module Script
+
+end # module Cosmos