cosmos 4.0.0 → 4.0.1

data/lib/cosmos/script/api_shared.rb

@@ -14,25 +14,6 @@ module Cosmos
 
     private
 
-    # 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
-
     # Creates a string with the parameters upcased
     def _upcase(target_name, packet_name, item_name)
       "#{target_name.upcase} #{packet_name.upcase} #{item_name.upcase}"
@@ -984,17 +965,8 @@ module Cosmos
 
     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
+      Cosmos.run_cosmos_tool('TlmViewer', "--system #{system_file}")
       cosmos_script_sleep(1)
     end
-
   end
 end

data/lib/cosmos/script/scripting.rb

@@ -140,7 +140,5 @@ module Cosmos
     def prompt_combo_box(string, options)
       prompt_message_box(string, options)
     end
-
-  end # module Script
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/script/telemetry.rb

@@ -9,7 +9,6 @@
 # attribution addendums as found in the LICENSE.txt
 
 module Cosmos
-
   module Script
     private
 
@@ -19,7 +18,7 @@ module Cosmos
     # or
     #   tlm('target_name packet_name item_name')
     def tlm(*args)
-      return $cmd_tlm_server.tlm(*args)
+      $cmd_tlm_server.tlm(*args)
     end
 
     # Poll for the raw value of a telemetry item
@@ -28,7 +27,7 @@ module Cosmos
     # or
     #   tlm_raw('target_name packet_name item_name')
     def tlm_raw(*args)
-      return $cmd_tlm_server.tlm_raw(*args)
+      $cmd_tlm_server.tlm_raw(*args)
     end
 
     # Poll for the formatted value of a telemetry item
@@ -37,7 +36,7 @@ module Cosmos
     # or
     #   tlm_formatted('target_name packet_name item_name')
     def tlm_formatted(*args)
-      return $cmd_tlm_server.tlm_formatted(*args)
+      $cmd_tlm_server.tlm_formatted(*args)
     end
 
     # Poll for the formatted with units value of a telemetry item
@@ -46,11 +45,11 @@ module Cosmos
     # or
     #   tlm_with_units('target_name packet_name item_name')
     def tlm_with_units(*args)
-      return $cmd_tlm_server.tlm_with_units(*args)
+      $cmd_tlm_server.tlm_with_units(*args)
     end
 
     def tlm_variable(*args)
-      return $cmd_tlm_server.tlm_variable(*args)
+      $cmd_tlm_server.tlm_variable(*args)
     end
 
     # Set a telemetry point to a given value. Note this will be over written in
@@ -60,7 +59,7 @@ module Cosmos
     # or
     #   set_tlm("target_name packet_name item_name = value")
     def set_tlm(*args)
-      return $cmd_tlm_server.set_tlm(*args)
+      $cmd_tlm_server.set_tlm(*args)
     end
 
     # Set the raw value of a telemetry point to a given value. Note this will
@@ -70,7 +69,7 @@ module Cosmos
     # or
     #   set_tlm_raw("target_name packet_name item_name = value")
     def set_tlm_raw(*args)
-      return $cmd_tlm_server.set_tlm_raw(*args)
+      $cmd_tlm_server.set_tlm_raw(*args)
     end
 
     # Injects a packet into the system as if it was received from an interface
@@ -83,7 +82,7 @@ module Cosmos
     # @param send_packet_log_writers[Boolean] Whether or not to send to the packet log writers for the target's interface
     # @param create_new_logs[Boolean] Whether or not to create new log files before writing this packet to logs
     def inject_tlm(target_name, packet_name, item_hash = nil, value_type = :CONVERTED, send_routers = true, send_packet_log_writers = true, create_new_logs = false)
-      return $cmd_tlm_server.inject_tlm(target_name, packet_name, item_hash, value_type, send_routers, send_packet_log_writers, create_new_logs)
+      $cmd_tlm_server.inject_tlm(target_name, packet_name, item_hash, value_type, send_routers, send_packet_log_writers, create_new_logs)
     end
 
     # Permanently set the converted value of a telemetry point to a given value
@@ -92,7 +91,7 @@ module Cosmos
     # or
     #   override_tlm("target_name packet_name item_name = value")
     def override_tlm(*args)
-      return $cmd_tlm_server.override_tlm(*args)
+      $cmd_tlm_server.override_tlm(*args)
     end
 
     # Permanently set the raw value of a telemetry point to a given value
@@ -101,7 +100,7 @@ module Cosmos
     # or
     #   override_tlm_raw("target_name packet_name item_name = value")
     def override_tlm_raw(*args)
-      return $cmd_tlm_server.override_tlm_raw(*args)
+      $cmd_tlm_server.override_tlm_raw(*args)
     end
 
     # Clear an override of a telemetry point
@@ -110,7 +109,7 @@ module Cosmos
     # or
     #   normalize_tlm("target_name packet_name item_name")
     def normalize_tlm(*args)
-      return $cmd_tlm_server.normalize_tlm(*args)
+      $cmd_tlm_server.normalize_tlm(*args)
     end
 
     # Gets all the values from the given packet returned in a two dimensional
@@ -144,18 +143,18 @@ module Cosmos
     # 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)
+      $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)
+      $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
+      $cmd_tlm_server.get_target_list
     end
 
     def get_tlm_details(items)
@@ -164,7 +163,7 @@ module Cosmos
 
     # Returns the buffer from the telemetry packet.
     def get_tlm_buffer(target_name, packet_name)
-      return $cmd_tlm_server.get_tlm_buffer(target_name, packet_name)
+      $cmd_tlm_server.get_tlm_buffer(target_name, packet_name)
     end
 
     # Subscribe to one or more telemetry packets. The queue ID is returned for
@@ -172,8 +171,7 @@ module Cosmos
     # 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
+      $cmd_tlm_server.subscribe_packet_data(packets, queue_size)
     end
 
     # Unsubscribe to telemetry packets. Pass the queue ID which was returned by
@@ -181,11 +179,10 @@ module Cosmos
     # Usage:
     #   unsubscribe_packet_data(id)
     def unsubscribe_packet_data(id)
-      result = $cmd_tlm_server.unsubscribe_packet_data(id)
-      result
+      $cmd_tlm_server.unsubscribe_packet_data(id)
     end
 
-    # DEPRECATED
+    # DEPRECATED for Ruby APIs although still necessary
     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]
@@ -195,6 +192,25 @@ module Cosmos
       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
+      # The get_packet_data above returns a Ruby time after the packet_name.
+      # This is different from the API.s
+      buffer, target_name, packet_name, time, rx_count = get_packet_data(id, non_block)
+      if buffer
+        packet = System.telemetry.packet(target_name, packet_name).clone
+        packet.buffer = buffer
+        packet.received_time = time
+        packet.received_count = rx_count
+      end
+      packet
+    end
   end
 end
-

data/lib/cosmos/system/system.rb

@@ -105,6 +105,7 @@ module Cosmos
       @limits_set = :DEFAULT
       @use_utc = false
       @additional_md5_files = []
+      @meta_init_filename = nil
 
       @ports = {}
       @ports['CTS_API'] = 7777
@@ -150,7 +151,6 @@ module Cosmos
 
       @initial_filename = filename
       @initial_config = nil
-      @meta_init_filename = nil
       @@instance = self
     end
 
@@ -687,64 +687,27 @@ module Cosmos
     def setup_system_meta
       # Ensure SYSTEM META is defined and defined correctly
       begin
+        if @commands.target_names.include?("SYSTEM")
+          pkts = @commands.packets('SYSTEM')
+          # User should not define COMMAND SYSTEM META as we build it to match TELEMETRY
+          raise "COMMAND SYSTEM META defined" if pkts.keys.include?('META')
+        end
         tlm_meta = @telemetry.packet('SYSTEM', 'META')
-        cmd_meta = @commands.packet('SYSTEM', 'META')
         item = tlm_meta.get_item('PKTID')
-        raise "PKTID Incorrect" unless (item.bit_size == 8) && (item.bit_offset == 0)
-        item = cmd_meta.get_item('PKTID')
-        raise "PKTID Incorrect" unless (item.bit_size == 8) && (item.bit_offset == 0)
+        raise "PKTID incorrect" unless (item.bit_size == 8) && (item.bit_offset == 0)
         item = tlm_meta.get_item('CONFIG')
-        raise "CONFIG Incorrect" unless (item.bit_size == 256) && (item.bit_offset == 8)
-        item = cmd_meta.get_item('CONFIG')
-        raise "CONFIG Incorrect" unless (item.bit_size == 256) && (item.bit_offset == 8)
+        raise "CONFIG incorrect" unless (item.bit_size == 256) && (item.bit_offset == 8)
         item = tlm_meta.get_item('COSMOS_VERSION')
-        raise "CONFIG Incorrect" unless (item.bit_size == 240) && (item.bit_offset == 264)
-        item = cmd_meta.get_item('COSMOS_VERSION')
-        raise "CONFIG Incorrect" unless (item.bit_size == 240) && (item.bit_offset == 264)
+        raise "COSMOS_VERSION incorrect" unless (item.bit_size == 240) && (item.bit_offset == 264)
         item = tlm_meta.get_item('USER_VERSION')
-        raise "CONFIG Incorrect" unless (item.bit_size == 240) && (item.bit_offset == 504)
-        item = cmd_meta.get_item('USER_VERSION')
-        raise "CONFIG Incorrect" unless (item.bit_size == 240) && (item.bit_offset == 504)
+        raise "USER_VERSION incorrect" unless (item.bit_size == 240) && (item.bit_offset == 504)
         item = tlm_meta.get_item('RUBY_VERSION')
-        raise "CONFIG Incorrect" unless (item.bit_size == 240) && (item.bit_offset == 744)
-        item = cmd_meta.get_item('RUBY_VERSION')
-        raise "CONFIG Incorrect" unless (item.bit_size == 240) && (item.bit_offset == 744)
-      rescue
-        Logger.error "SYSTEM META not defined or defined incorrectly - defaulting"
-
-        cmd_meta = Packet.new('SYSTEM', 'META', :BIG_ENDIAN)
-        item = cmd_meta.append_item('PKTID', 8, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 1)
-        item.range = 1..1
-        item.default = 1
-        item.description = 'Packet Id'
-        item = cmd_meta.append_item('CONFIG', 32 * 8, :STRING)
-        item.default = ''
-        item.description = 'Configuration Name'
-        item = cmd_meta.append_item('COSMOS_VERSION', 30 * 8, :STRING)
-        item.default = ''
-        item.description = 'COSMOS Version'
-        item = cmd_meta.append_item('USER_VERSION', 30 * 8, :STRING)
-        item.default = ''
-        item.description = 'User Project Version'
-        item = cmd_meta.append_item('RUBY_VERSION', 30 * 8, :STRING)
-        item.default = ''
-        item.description = 'Ruby Version'
-        @config.commands['SYSTEM'] ||= {}
-        @config.commands['SYSTEM']['META'] = cmd_meta
-
-        tlm_meta = Packet.new('SYSTEM', 'META', :BIG_ENDIAN)
-        item = tlm_meta.append_item('PKTID', 8, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 1)
-        item.description = 'Packet Id'
-        item = tlm_meta.append_item('CONFIG', 32 * 8, :STRING)
-        item.description = 'Configuration Name'
-        item = tlm_meta.append_item('COSMOS_VERSION', 30 * 8, :STRING)
-        item.description = 'COSMOS Version'
-        item = tlm_meta.append_item('USER_VERSION', 30 * 8, :STRING)
-        item.description = 'User Project Version'
-        item = tlm_meta.append_item('RUBY_VERSION', 30 * 8, :STRING)
-        item.description = 'Ruby Version'
-        @config.telemetry['SYSTEM'] ||= {}
-        @config.telemetry['SYSTEM']['META'] = tlm_meta
+        raise "RUBY_VERSION incorrect" unless (item.bit_size == 240) && (item.bit_offset == 744)
+        cmd_meta = build_cmd_system_meta()
+      rescue => err
+        Logger.error "SYSTEM META not defined correctly due to #{err.message} - defaulting"
+        tlm_meta = build_tlm_system_meta()
+        cmd_meta = build_cmd_system_meta()
       end
 
       # Initialize the meta packet (if given init filename)
@@ -776,5 +739,40 @@ module Cosmos
 
       cmd_meta.buffer = tlm_meta.buffer
     end
+
+    def build_cmd_system_meta
+      cmd_meta = Packet.new('SYSTEM', 'META', :BIG_ENDIAN)
+      cmd_meta.disabled = true
+      tlm_meta = @telemetry.packet('SYSTEM', 'META')
+      tlm_meta.sorted_items.each do |item|
+        next if item.name.include?("RECEIVED") # Tlm only items
+        cmd_meta.define(item.clone)
+      end
+      @config.commands['SYSTEM'] ||= {}
+      @config.commands['SYSTEM']['META'] = cmd_meta
+      cmd_meta
+    end
+
+    def build_tlm_system_meta
+      tlm_meta = Packet.new('SYSTEM', 'META', :BIG_ENDIAN)
+      item = tlm_meta.append_item('PKTID', 8, :UINT, nil, :BIG_ENDIAN, :ERROR, nil, nil, nil, 1)
+      item.description = 'Packet Id'
+      item.meta["READ_ONLY"] = []
+      item = tlm_meta.append_item('CONFIG', 32 * 8, :STRING)
+      item.description = 'Configuration Name'
+      item.meta["READ_ONLY"] = []
+      item = tlm_meta.append_item('COSMOS_VERSION', 30 * 8, :STRING)
+      item.description = 'COSMOS Version'
+      item.meta["READ_ONLY"] = []
+      item = tlm_meta.append_item('USER_VERSION', 30 * 8, :STRING)
+      item.description = 'User Project Version'
+      item.meta["READ_ONLY"] = []
+      item = tlm_meta.append_item('RUBY_VERSION', 30 * 8, :STRING)
+      item.description = 'Ruby Version'
+      item.meta["READ_ONLY"] = []
+      @config.telemetry['SYSTEM'] ||= {}
+      @config.telemetry['SYSTEM']['META'] = tlm_meta
+      tlm_meta
+    end
   end
 end

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

@@ -532,10 +532,12 @@ module Cosmos
       packet = cvt_packet.clone
       packet.received_time = received_time
 
-      # Update the packet with item_hash
-      value_type = value_type.to_s.intern
-      item_hash.each do |item_name, item_value|
-        packet.write(item_name, item_value, value_type)
+      if item_hash
+        # Update the packet with item_hash
+        value_type = value_type.to_s.intern
+        item_hash.each do |item_name, item_value|
+          packet.write(item_name, item_value, value_type)
+        end
       end
 
       # Update current value table
@@ -945,6 +947,27 @@ module Cosmos
       CmdTlmServer.get_packet_data(id, non_block)
     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
+      # The get_packet_data in the CmdTlmServer returns the number of seconds
+      # followed by microseconds after the packet_name. This is different that the Script API.
+      buffer, target_name, packet_name, rx_sec, rx_usec, rx_count = get_packet_data(id, non_block)
+      if buffer
+        packet = System.telemetry.packet(target_name, packet_name).clone
+        packet.buffer = buffer
+        packet.received_time = Time.at(rx_sec, rx_usec).sys
+        packet.received_count = rx_count
+      end
+      packet
+    end
+
     #
     # Methods for scripting
     #

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

@@ -137,13 +137,7 @@ 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
-          if Kernel.is_windows?
-            Cosmos.run_process("rubyw tools/#{tool_name} -p \"#{target_name} #{packet_name}\" --system #{File.basename(System.initial_filename)}")
-          elsif Kernel.is_mac? and File.exist?("tools/mac/#{tool_name}.app")
-            Cosmos.run_process("open tools/mac/#{tool_name}.app --args -p \"#{target_name} #{packet_name}\" --system #{File.basename(System.initial_filename)}")
-          else
-            Cosmos.run_process("ruby tools/#{tool_name} -p \"#{target_name} #{packet_name}\" --system #{File.basename(System.initial_filename)}")
-          end
+          Cosmos.run_cosmos_tool(tool_name, "-p \"#{target_name} #{packet_name}\" --system #{File.basename(System.initial_filename)}")
         end
         table.setCellWidget(row, 4, view_pv)
       else

data/lib/cosmos/tools/config_editor/config_editor.rb

@@ -75,7 +75,11 @@ module Cosmos
       initialize_central_widget()
       complete_initialize()
 
-      create_tab()
+      if options.filename
+        file_open(options.filename)
+      else
+        create_tab()
+      end
     end
 
     def initialize_actions
@@ -712,6 +716,10 @@ module Cosmos
           options.height = 600
           options.title = "Config Editor : #{UNTITLED}"
           options.auto_size = false
+          option_parser.separator "Config Editor Specific Options:"
+          option_parser.on("-f", "--file FILENAME", "Open the specified configuration file") do |arg|
+            options.filename = arg
+          end
         end
         super(option_parser, options)
       end