cosmos 4.0.3 → 4.1.0

data/demo/config/targets/INST/cmd_tlm_server.txt

@@ -3,3 +3,4 @@
 
 INTERFACE INST_INT simulated_target_interface.rb sim_inst.rb
   TARGET INST
+  PROTOCOL READ_WRITE OverrideProtocol

data/demo/config/targets/INST/cmd_tlm_server2.txt

@@ -0,0 +1,7 @@
+# This is a segment of the main cmd_tlm_server.txt that will be used with
+# AUTO_INTERFACE_TARGETS or INTERFACE_TARGET
+
+INTERFACE INST2_INT simulated_target_interface.rb sim_inst.rb
+  TARGET INST2
+  DONT_LOG
+  PROTOCOL READ_WRITE OverrideProtocol

data/demo/config/tools/cmd_sequence/cmd_sequence.txt

@@ -0,0 +1,2 @@
+# Declare a custom export class
+EXPORTER cmd_sequence_exporter.rb

data/demo/config/tools/cmd_tlm_server/cmd_tlm_server.txt

@@ -11,18 +11,11 @@ TITLE 'COSMOS Command and Telemetry Server - Demo Configuration'
 PACKET_LOG_WRITER DEFAULT packet_log_writer.rb nil true nil 2000000000 nil false
 # PACKET_LOG_WRITER SYSTEMLOG packet_log_writer.rb system
 
-# AUTO_INTERFACE_TARGETS # Use cmd_tlm_server.txt from all targets declared in system.txt
-
-INTERFACE_TARGET INST cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
-
-INTERFACE INST2_INT simulated_target_interface.rb sim_inst.rb
-  TARGET INST2
-  DONT_LOG
-
-INTERFACE_TARGET EXAMPLE cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
-
-INTERFACE_TARGET TEMPLATED cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
+# Explicitly declare these interfaces since we're using name substitution
+INTERFACE_TARGET INST cmd_tlm_server.txt # Use cmd_tlm_server.txt in targets/INST
+INTERFACE_TARGET INST2 cmd_tlm_server2.txt # Use cmd_tlm_server2.txt in targets/INST
 
+# Here is an example of declaring the interface directly
 INTERFACE SYSTEM_INT cmd_tlm_server_interface.rb
   TARGET SYSTEM
   DISABLE_DISCONNECT
@@ -33,6 +26,9 @@ INTERFACE SYSTEM_INT cmd_tlm_server_interface.rb
   # RECONNECT_DELAY 15.0
   # LOG_RAW
 
+# Auto interface the rest of the targets by using their cmd_tlm_server.txt file
+AUTO_INTERFACE_TARGETS
+
 ROUTER INST_ROUTER tcpip_server_interface.rb 2055 2055 10.0 nil LENGTH 32 16 7
   OPTION LISTEN_ADDRESS 127.0.0.1
   ROUTE INST_INT
@@ -46,4 +42,4 @@ BACKGROUND_TASK example_background_task.rb
   STOPPED
 BACKGROUND_TASK limits_groups.rb 5 # Initial delay to allow interfaces to connect
 
-COLLECT_METADATA
+#COLLECT_METADATA

data/demo/config/tools/cmd_tlm_server/cmd_tlm_server2.txt

@@ -11,16 +11,11 @@ TITLE 'COSMOS Command and Telemetry Server - Demo Configuration 2'
 PACKET_LOG_WRITER DEFAULT packet_log_writer.rb nil true nil 2000000000 nil false
 # PACKET_LOG_WRITER SYSTEMLOG packet_log_writer.rb system
 
-# AUTO_INTERFACE_TARGETS # Use cmd_tlm_server.txt from all targets declared in system.txt
-
-INTERFACE_TARGET INST cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
-
-INTERFACE INST2_INT simulated_target_interface.rb sim_inst.rb
-  TARGET INST2
-  DONT_LOG
-
-INTERFACE_TARGET EXAMPLE cmd_tlm_server.txt # Use cmd_tlm_server.txt in target package
+# Explicitly declare these interfaces since we're using name substitution
+INTERFACE_TARGET INST cmd_tlm_server.txt # Use cmd_tlm_server.txt in targets/INST
+INTERFACE_TARGET INST2 cmd_tlm_server2.txt # Use cmd_tlm_server2.txt in targets/INST
 
+# Here is an example of declaring the interface directly
 INTERFACE SYSTEM_INT cmd_tlm_server_interface.rb
   TARGET SYSTEM
   DISABLE_DISCONNECT
@@ -31,6 +26,9 @@ INTERFACE SYSTEM_INT cmd_tlm_server_interface.rb
   # RECONNECT_DELAY 15.0
   # LOG_RAW
 
+# Auto interface the rest of the targets by using their cmd_tlm_server.txt file
+AUTO_INTERFACE_TARGETS
+
 ROUTER INST_ROUTER tcpip_server_interface.rb 3055 3055 10.0 nil LENGTH 32 16 7
   ROUTE INST_INT
   # DONT_CONNECT

data/demo/lib/cmd_sequence_exporter.rb

@@ -0,0 +1,52 @@
+# 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/ccsds/ccsds_packet'
+
+module Cosmos
+  class CmdSequenceExporter
+    def initialize(parent)
+      @parent = parent
+    end
+
+    def export(filename, sequence_dir, sequence_list)
+      basename = File.basename(filename, ".*")
+      filename = Qt::FileDialog::getSaveFileName(@parent,   # parent
+                                                 'Export', # caption
+                                                 sequence_dir + "/#{basename}.bin", # dir
+                                                 'Sequence Binary (*.bin)') # filter
+      return if filename.nil? || filename.empty?
+
+      data = ''
+      sequence_list.each do |item|
+        begin
+          time = Time.parse(item.time)
+          day, ms, us = Time.mdy2ccsds(time.year, time.month, time.day, time.hour, time.min, time.sec, time.usec)
+          data << [day].pack("N") # UINT32
+          data << [ms].pack("N") # UINT32
+        rescue
+          time = item.time.to_f * 1000
+          data << [0].pack("N") # UINT32
+          data << [time].pack("N") # UINT32
+        end
+        data << item.command.buffer
+      end
+      ccsds = CcsdsPacket.new
+      ccsds.write("CCSDSTYPE", CcsdsPacket::COMMAND)
+      ccsds.write('CCSDSSHF', 0)
+      ccsds.write("CCSDSAPID", 505)
+      ccsds.write("CCSDSSEQFLAGS", CcsdsPacket::STANDALONE)
+      ccsds.write("CCSDSDATA", data)
+      ccsds.write("CCSDSLENGTH", data.length - 1)
+      File.open(filename, 'wb') { |file| file.write ccsds.buffer }
+    end
+  end
+end

data/demo/lib/example_background_task.rb

@@ -18,6 +18,7 @@ module Cosmos
     def initialize
       super()
       @name = 'Example Background Task'
+      @sleeper = Sleeper.new
     end
 
     def call

data/demo/procedures/replay_test.rb

@@ -0,0 +1,32 @@
+set_line_delay(0)
+set_replay_mode(true)
+filenames = get_output_logs_filenames()
+replay_select_file(filenames[-1])
+status = 'Analyzing'
+while status =~ /Analyzing/
+  status, playback_delay, filename, file_start, file_current, file_end, file_index, file_max_index = replay_status
+  wait(1)
+end
+100.times do
+  replay_step_forward()
+end
+100.times do
+  replay_step_back()
+end
+replay_move_end()
+replay_move_index(file_max_index / 2)
+replay_move_start()
+replay_set_playback_delay(0.1)
+replay_play()
+wait(2)
+replay_set_playback_delay(0.125)
+wait(5)
+replay_set_playback_delay(nil)
+wait(2)
+replay_set_playback_delay(0.0)
+wait(4)
+replay_stop()
+replay_reverse_play()
+wait(5)
+cmd_tlm_clear_counters()
+cmd_tlm_reload()

data/ext/cosmos/ext/structure/structure.c

@@ -64,6 +64,7 @@ static ID id_ivar_neg_bit_size = 0;
 static ID id_ivar_fixed_size = 0;
 static ID id_ivar_short_buffer_allowed = 0;
 static ID id_ivar_mutex = 0;
+static ID id_ivar_create_index = 0;
 
 static ID id_const_ASCII_8BIT_STRING = 0;
 static ID id_const_ZERO_STRING = 0;
@@ -1189,6 +1190,16 @@ static VALUE structure_item_spaceship(VALUE self, VALUE other_item) {
   int other_bit_offset = FIX2INT(rb_ivar_get(other_item, id_ivar_bit_offset));
   int bit_size = 0;
   int other_bit_size = 0;
+  int create_index = 0;
+  int other_create_index = 0;
+  int have_create_index = 0;
+  volatile VALUE v_create_index = rb_ivar_get(self, id_ivar_create_index);
+  volatile VALUE v_other_create_index = rb_ivar_get(other_item, id_ivar_create_index);
+  if (RTEST(v_create_index) && RTEST(v_other_create_index)) {
+    create_index = FIX2INT(v_create_index);
+    other_create_index = FIX2INT(v_other_create_index);
+    have_create_index = 1;
+  }
 
   /* Handle same bit offset case */
   if ((bit_offset == 0) && (other_bit_offset == 0)) {
@@ -1198,7 +1209,15 @@ static VALUE structure_item_spaceship(VALUE self, VALUE other_item) {
     bit_size = FIX2INT(rb_ivar_get(self, id_ivar_bit_size));
     other_bit_size = FIX2INT(rb_ivar_get(other_item, id_ivar_bit_size));
     if (bit_size == other_bit_size) {
-      return INT2FIX(0);
+      if (have_create_index) {
+        if (create_index <= other_create_index) {
+          return INT2FIX(-1);
+        } else {
+          return INT2FIX(1);
+        }
+      } else {
+        return INT2FIX(0);
+      }
     } if (bit_size < other_bit_size) {
       return INT2FIX(-1);
     } else {
@@ -1210,7 +1229,15 @@ static VALUE structure_item_spaceship(VALUE self, VALUE other_item) {
   if (((bit_offset >= 0) && (other_bit_offset >= 0)) || ((bit_offset < 0) && (other_bit_offset < 0))) {
     /* Both Have Same Sign */
     if (bit_offset == other_bit_offset) {
-      return INT2FIX(0);
+      if (have_create_index) {
+        if (create_index <= other_create_index) {
+          return INT2FIX(-1);
+        } else {
+          return INT2FIX(1);
+        }
+      } else {
+        return INT2FIX(0);
+      }
     } else if (bit_offset < other_bit_offset) {
       return INT2FIX(-1);
     } else {
@@ -1219,7 +1246,15 @@ static VALUE structure_item_spaceship(VALUE self, VALUE other_item) {
   } else {
     /* Different Signs */
     if (bit_offset == other_bit_offset) {
-      return INT2FIX(0);
+      if (have_create_index) {
+        if (create_index <= other_create_index) {
+          return INT2FIX(-1);
+        } else {
+          return INT2FIX(1);
+        }
+      } else {
+        return INT2FIX(0);
+      }
     } else if (bit_offset < other_bit_offset) {
       return INT2FIX(1);
     } else {
@@ -1387,6 +1422,7 @@ void Init_structure (void)
   id_ivar_fixed_size = rb_intern("@fixed_size");
   id_ivar_short_buffer_allowed = rb_intern("@short_buffer_allowed");
   id_ivar_mutex = rb_intern("@mutex");
+  id_ivar_create_index = rb_intern("@create_index");
 
   symbol_LITTLE_ENDIAN = ID2SYM(rb_intern("LITTLE_ENDIAN"));
   symbol_BIG_ENDIAN = ID2SYM(rb_intern("BIG_ENDIAN"));

data/install/config/tools/cmd_tlm_server/cmd_tlm_server.txt

@@ -1,2 +1,3 @@
 TITLE 'COSMOS Command and Telemetry Server'
 AUTO_INTERFACE_TARGETS # Use cmd_tlm_server.txt from all targets declared in system.txt
+COLLECT_METADATA

data/install/config/tools/launcher/launcher.txt

@@ -20,6 +20,7 @@ DIVIDER
 LABEL "Commanding and Scripting"
 
 TOOL "Command Sender" "LAUNCH CmdSender" "cmd_sender.png"
+TOOL "Command Sequence" "LAUNCH CmdSequence" "cmd_sequence.png"
 TOOL "Script Runner" "LAUNCH ScriptRunner" "script_runner.png"
 TOOL "Test Runner" "LAUNCH TestRunner" "test_runner.png"
 
@@ -34,6 +35,7 @@ TOOL "Data Viewer" "LAUNCH DataViewer" "data_viewer.png"
 DIVIDER
 LABEL Utilities
 
+TOOL "Config Editor" "LAUNCH ConfigEditor" "config_editor.png"
 TOOL "Telemetry Extractor" "LAUNCH TlmExtractor" "tlm_extractor.png"
 TOOL "Command Extractor" "LAUNCH CmdExtractor" "cmd_extractor.png"
 TOOL "Handbook Creator" "LAUNCH HandbookCreator" "handbook_creator.png"

data/lib/cosmos/config/config_parser.rb

@@ -146,6 +146,7 @@ module Cosmos
 
     # Called by the ERB template to render a partial
     def render(template_name, options = {})
+      raise Error.new(self, "Partial name '#{template_name}' must begin with an underscore.") if template_name[0] != '_'
       b = binding
       if options[:locals]
         if RUBY_VERSION.split('.')[0..1].join.to_i >= 21
@@ -178,6 +179,7 @@ module Cosmos
                    yield_non_keyword_lines = false,
                    remove_quotes = true,
                    &block)
+      raise "Configuration file #{filename} does not exist." unless filename && File.exist?(filename)
       @filename = filename
 
       # Create a temp file where we write the ERB parsed output

data/lib/cosmos/core_ext/io.rb

@@ -8,6 +8,7 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
+require 'cosmos/core_ext/kernel'
 require 'cosmos/core_ext/cosmos_io'
 
 class IO
@@ -20,74 +21,102 @@ class IO
   # remaining timeout is left.
   SELECT_MAX_TIMEOUT = 0.016
 
-  # The method is identical to IO.select but instead of calling IO.select with
-  # the full timeout, it calls IO.select with a small timeout and then
-  # doubles the timeout twice until eventually it calls IO.select with the
-  # remaining passed in timeout value.
-  # TODO: Ryan why was this originally done?
-  #
-  # @param read_sockets [Array<IO>] IO objects to wait to be ready to read
-  # @param write_sockets [Array<IO>] IO objects to wait to be ready to write
-  # @param error_array [Array<IO>] IO objects to wait for exceptions
-  # @param timeout [Numeric] Number of seconds to wait
-  def self.fast_select(read_sockets = nil, write_sockets = nil, error_array = nil, timeout = nil)
-    # Always try a zero timeout first
-    current_timeout = SELECT_BASE_TIMEOUT
-    total_timeout = 0.0
+  class << self
 
-    while true
-      result = IO.select(read_sockets, write_sockets, error_array, current_timeout)
-      return result if result or current_timeout.nil?
-      return nil if timeout and total_timeout >= timeout
+    # Alias the original IO.select method
+    alias_method :__select__, :select
 
-      if current_timeout <= 0.0001
-        # Always try the base timeout next
-        current_timeout = SELECT_BASE_TIMEOUT
-        total_timeout = SELECT_BASE_TIMEOUT
-      else
-        # Then start doubling the timeout
-        current_timeout = current_timeout * 2
-
-        # Until it is bigger than our max timeout
-        if current_timeout >= SELECT_MAX_TIMEOUT
-          if timeout
-            # Block for the remaining requested timeout
-            current_timeout = timeout - total_timeout
-            total_timeout = timeout
-          else
-            # Or block forever
-            current_timeout = nil
-          end
+    # On Windows the IO.select function (when called with no timeout) takes
+    # a minimum of 10 msec to return, even if one of the IO objects is
+    # ready to read/write sooner than that.
+    # 
+    # This method is identical to IO.select but instead of calling IO.select with
+    # the full timeout, it calls IO.select with a small timeout and then
+    # doubles the timeout twice until eventually it calls IO.select with the
+    # remaining passed in timeout value.
+    #
+    # @param read_sockets [Array<IO>] IO objects to wait to be ready to read
+    # @param write_sockets [Array<IO>] IO objects to wait to be ready to write
+    # @param error_array [Array<IO>] IO objects to wait for exceptions
+    # @param timeout [Numeric] Number of seconds to wait
+    def fast_select(read_sockets = nil, write_sockets = nil, error_array = nil, timeout = nil)
+      # Always try a zero timeout first
+      current_timeout = SELECT_BASE_TIMEOUT
+      total_timeout = 0.0
+    
+      while true
+        result = IO.__select__(read_sockets, write_sockets, error_array, current_timeout)
+        return result if result or current_timeout.nil?
+        return nil if timeout and total_timeout >= timeout
+    
+        if current_timeout <= 0.0001
+          # Always try the base timeout next
+          current_timeout = SELECT_BASE_TIMEOUT
+          total_timeout = SELECT_BASE_TIMEOUT
         else
-          # Or it is bigger than the given timeout
-          if timeout and current_timeout >= timeout
-            # Block for the remaining requested timeout
-            current_timeout = timeout - total_timeout
-            total_timeout = timeout
+          # Then start doubling the timeout
+          current_timeout = current_timeout * 2
+    
+          # Until it is bigger than our max timeout
+          if current_timeout >= SELECT_MAX_TIMEOUT
+            if timeout
+              # Block for the remaining requested timeout
+              current_timeout = timeout - total_timeout
+              total_timeout = timeout
+            else
+              # Or block forever
+              current_timeout = nil
+            end
           else
-            # Up our total time in select
-            total_timeout += current_timeout
-          end
-          if timeout and total_timeout > timeout
-            # Block for the remaining requested timeout
-            current_timeout = timeout - total_timeout
-            total_timeout = timeout
+            # Or it is bigger than the given timeout
+            if timeout and current_timeout >= timeout
+              # Block for the remaining requested timeout
+              current_timeout = timeout - total_timeout
+              total_timeout = timeout
+            else
+              # Up our total time in select
+              total_timeout += current_timeout
+            end
+            if timeout and total_timeout > timeout
+              # Block for the remaining requested timeout
+              current_timeout = timeout - total_timeout
+              total_timeout = timeout
+            end
           end
+          return nil if current_timeout and current_timeout < 0
         end
-        return nil if current_timeout and current_timeout < 0
-      end
-    end # while true
-  end # fast_select
+      end # while true
+    end # fast_select
 
-  # @param read_sockets [Array<IO>] IO objects to wait to be ready to read
-  # @param timeout [Numeric] Number of seconds to wait
-  def self.fast_read_select(read_sockets, timeout)
-    return fast_select(read_sockets, nil, nil, timeout)
+    # For non-windows systems, leave IO.select alone, but for windows
+    # monkey-patch IO.select to use our fast-select implementation.
+    if Kernel.is_windows?
+      def select(read_sockets = nil, write_sockets = nil, error_array = nil, timeout = nil)
+        return fast_select(read_sockets, write_sockets, error_array, timeout)
+      end
+    end
+    
+    # @param read_sockets [Array<IO>] IO objects to wait to be ready to read
+    # @param timeout [Numeric] Number of seconds to wait
+    def fast_read_select(read_sockets, timeout)
+      return fast_select(read_sockets, nil, nil, timeout)
+    end
+    
+    # @param write_sockets [Array<IO>] IO objects to wait to be ready to write
+    # @param timeout [Numeric] Number of seconds to wait
+    def fast_write_select(write_sockets, timeout)
+      return fast_select(nil, write_sockets, nil, timeout)
+    end
   end
 
-  # @param write_sockets [Array<IO>] IO objects to wait to be ready to write
-  # @param timeout [Numeric] Number of seconds to wait
-  def self.fast_write_select(write_sockets, timeout)
-    return fast_select(nil, write_sockets, nil, timeout)
+  # Alias the original close method
+  alias_method :__close__, :close
+
+  # Patch the close method so that it won't raise any exceptions
+  def close
+    begin
+      __close__
+    rescue
+    end
   end
 end