cosmos 3.4.2 → 3.5.0

data/lib/cosmos/system/system.rb

@@ -17,6 +17,7 @@ require 'cosmos/system/target'
 require 'cosmos/packet_logs'
 require 'fileutils'
 require 'drb/acl'
+require 'bundler'
 
 module Cosmos
 
@@ -39,6 +40,8 @@ module Cosmos
     instance_attr_reader :default_packet_log_writer
     # @return [PacketLogReader] Class used to read log files
     instance_attr_reader :default_packet_log_reader
+    # @return [Boolean] Whether to use sound for alerts
+    instance_attr_reader :sound
     # @return [Boolean] Whether to use DNS to lookup IP addresses or not
     instance_attr_reader :use_dns
     # @return [String] Stores the initial configuration file used when this
@@ -81,7 +84,8 @@ module Cosmos
       @cmd_tlm_version = nil
       @default_packet_log_writer = PacketLogWriter
       @default_packet_log_reader = PacketLogReader
-      @use_dns = true
+      @sound = false
+      @use_dns = false
       @acl = nil
       @staleness_seconds = 30
       @limits_set = :DEFAULT
@@ -222,7 +226,7 @@ module Cosmos
         # First pass - Everything except targets
         parser.parse_file(filename) do |keyword, parameters|
           case keyword
-          when 'AUTO_DECLARE_TARGETS', 'DECLARE_TARGET'
+          when 'AUTO_DECLARE_TARGETS', 'DECLARE_TARGET', 'DECLARE_GEM_TARGET'
             # Will be handled by second pass
 
           when 'PORT'
@@ -267,11 +271,21 @@ module Cosmos
             parser.verify_num_parameters(1, 1, usage)
             @default_packet_log_reader = Cosmos.require_class(parameters[0])
 
+          when 'ENABLE_SOUND'
+            usage = "#{keyword}"
+            parser.verify_num_parameters(0, 0, usage)
+            @sound = true
+
           when 'DISABLE_DNS'
             usage = "#{keyword}"
             parser.verify_num_parameters(0, 0, usage)
             @use_dns = false
 
+          when 'ENABLE_DNS'
+            usage = "#{keyword}"
+            parser.verify_num_parameters(0, 0, usage)
+            @use_dns = true
+
           when 'ALLOW_ACCESS'
             parser.verify_num_parameters(1, 1, "#{keyword} <IP Address or Hostname>")
             begin
@@ -364,6 +378,9 @@ module Cosmos
               end
             end
           end
+
+          auto_detect_gem_based_targets()
+
           if system_found
             target = Target.new('SYSTEM')
             @targets[target.name] = target
@@ -386,6 +403,19 @@ module Cosmos
           end
           target = Target.new(target_name, substitute_name, configuration_directory, ConfigParser.handle_nil(parameters[2]))
           @targets[target.name] = target
+
+        when 'DECLARE_GEM_TARGET'
+          usage = "#{keyword} <GEM NAME> <SUBSTITUTE TARGET NAME (Optional)> <TARGET FILENAME (Optional - defaults to target.txt)>"
+          parser.verify_num_parameters(1, 3, usage)
+          # Remove 'cosmos' from the gem name 'cosmos-power-supply'
+          target_name = parameters[0].split('-')[1..-1].join('-').to_s.upcase
+          substitute_name = nil
+          substitute_name = ConfigParser.handle_nil(parameters[1])
+          substitute_name.to_s.upcase if substitute_name
+          gem_dir = Gem::Specification.find_by_name(parameters[0]).gem_dir
+          target = Target.new(target_name, substitute_name, configuration_directory, ConfigParser.handle_nil(parameters[2]), gem_dir)
+          @targets[target.name] = target
+
         end # case keyword
       end # parser.parse_file
     end
@@ -396,7 +426,7 @@ module Cosmos
     #
     # @param name [String] MD5 string which identifies the
     #   configuration. Pass nil to load the default configuration.
-    # @return [String] The actual configuration loaded
+    # @return [String, Exception/nil] The actual configuration loaded
     def load_configuration(name = nil)
       if name and @config
         # Make sure they're requesting something other than the current
@@ -412,24 +442,27 @@ module Cosmos
             if configuration_directory
               # We found the configuration requested. Reprocess the system.txt
               # and reload the packets
-              process_file(File.join(configuration_directory, 'system.txt'), configuration_directory)
-              load_packets()
+              begin
+                process_file(File.join(configuration_directory, 'system.txt'), configuration_directory)
+                load_packets(name)
+              rescue Exception => error
+                # Failed to load - Restore initial
+                update_config(@initial_config)
+                return @config.name, error
+              end
             else
               # We couldn't find the configuration request. Reload the
               # initial configuration
               update_config(@initial_config)
             end
           end
-          @telemetry.reset
         end
       else
         # Ensure packets have been lazy loaded
-        System.commands()
-        current_config = @config
-        @config = @initial_config
-        @telemetry.reset if current_config != @initial_config
+        System.commands
+        update_config(@initial_config)
       end
-      return @config.name
+      return @config.name, nil
     end
 
     # (see #load_configuration)
@@ -439,7 +472,24 @@ module Cosmos
 
     protected
 
+    def auto_detect_gem_based_targets
+      Bundler.load.specs.each do |spec|
+        spec_name_split = spec.name.split('-')
+        if spec_name_split.length > 1 and spec_name_split[0] == 'cosmos'
+          # Filter to just targets and not tools and other extensions
+          if File.exist?(File.join(spec.gem_dir, 'cmd_tlm'))
+            target_name = spec_name_split[1..-1].join('-').to_s.upcase
+            target = Target.new(target_name, nil, nil, nil, spec.gem_dir)
+            @targets[target.name] = target
+          end
+        end
+      end
+    rescue Bundler::GemfileNotFound
+      # No Gemfile - so no gem based targets
+    end
+
     def update_config(config)
+      current_config = @config
       unless @config
         @config = config
         @commands  = Commands.new(config)
@@ -451,6 +501,7 @@ module Cosmos
         @telemetry.config = config
         @limits.config = config
       end
+      @telemetry.reset if current_config != config
     end
 
     def find_configuration(name)
@@ -476,10 +527,9 @@ module Cosmos
 
             # Copy target files into directory
             @targets.each do |target_name, target|
-              source_dir = File.join(USERPATH, 'config', 'targets', target.original_name)
               destination_dir = File.join(configuration_directory, target.original_name)
               unless Dir.exist?(destination_dir)
-                FileUtils.cp_r(source_dir, destination_dir)
+                FileUtils.cp_r(target.dir, destination_dir)
               end
             end
 
@@ -502,9 +552,9 @@ module Cosmos
       end
     end
 
-    def load_packets
+    def load_packets(configuration_name = nil)
       # Determine MD5 over all targets cmd_tlm files
-      cmd_tlm_files = [System.initial_filename]
+      cmd_tlm_files = []
       additional_data = ''
       @targets.each do |target_name, target|
         cmd_tlm_files << target.filename if File.exist?(target.filename)
@@ -516,6 +566,7 @@ module Cosmos
           additional_data << target.original_name
         end
       end
+
       md5 = Cosmos.md5_files(cmd_tlm_files, additional_data)
       md5_string = md5.hexdigest
 
@@ -526,6 +577,8 @@ module Cosmos
       config = Cosmos.marshal_load(marshal_filename)
       if config
         update_config(config)
+        @config.name = configuration_name if configuration_name
+
         # Marshal file load successful
         Logger.info "Marshal load success: #{marshal_filename}"
         @config.warnings.each {|warning| Logger.warn(warning)} if @config.warnings
@@ -548,11 +601,14 @@ module Cosmos
         end
 
         # Create marshal file for next time
-        @config.name = md5_string
+        if configuration_name
+          @config.name = configuration_name
+        else
+          @config.name = md5_string
+        end
         Cosmos.marshal_dump(marshal_filename, @config)
       end
 
-      # Save configuration
       @initial_config = @config unless @initial_config
       save_configuration()
     end

data/lib/cosmos/system/target.rb

@@ -79,7 +79,8 @@ module Cosmos
     #   path to the default of <USERPATH>/config/targets.
     # @param target_filename [String] Configuration file for the target. Normally
     #   target.txt
-    def initialize(target_name, substitute_name = nil, path = nil, target_filename = nil)
+    # @param gem_path [String] Path to the gem file or nil if there is no gem
+    def initialize(target_name, substitute_name = nil, path = nil, target_filename = nil, gem_path = nil)
       @requires = []
       @ignored_parameters = []
       @ignored_items = []
@@ -100,7 +101,7 @@ module Cosmos
         @name = @original_name
       end
 
-      @dir = get_target_dir(path, @original_name)
+      @dir = get_target_dir(path, @original_name, gem_path)
       # Parse the target.txt file if it exists
       @filename = process_target_config_file(@dir, @name, target_filename)
       # If target.txt didn't specify specific cmd/tlm files then add everything
@@ -156,9 +157,13 @@ module Cosmos
 
     # Get the target directory and add the target's lib folder to the
     # search path if it exists
-    def get_target_dir(path, name)
-      path = File.join(USERPATH,'config','targets') unless path
-      dir = File.join(path, name)
+    def get_target_dir(path, name, gem_path)
+      if gem_path
+        dir = gem_path
+      else
+        path = File.join(USERPATH,'config','targets') unless path
+        dir = File.join(path, name)
+      end
       lib_dir = File.join(dir, 'lib')
       Cosmos.add_to_search_path(lib_dir, false) if File.exist?(lib_dir)
       dir

data/lib/cosmos/tools/cmd_extractor/cmd_extractor.rb

@@ -170,6 +170,7 @@ module Cosmos
       @input_filenames.each do |log_file|
         break if @cancel
         begin
+          Cosmos.check_log_configuration(@packet_log_reader, log_file)
           file_size = File.size(log_file).to_f
           progress_dialog.append_text("Processing File #{log_file_count}/#{@input_filenames.length}: #{log_file}")
           progress_dialog.set_step_progress(0.0)

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

@@ -31,6 +31,8 @@ module Cosmos
         'get_cmd_list',
         'get_cmd_param_list',
         'get_cmd_hazardous',
+        'get_cmd_value',
+        'get_cmd_time',
         'tlm',
         'tlm_raw',
         'tlm_formatted',
@@ -48,6 +50,7 @@ module Cosmos
         'limits_enabled?',
         'enable_limits',
         'disable_limits',
+        'get_stale',
         'get_limits',
         'set_limits',
         'get_limits_groups',
@@ -273,6 +276,80 @@ module Cosmos
       return hazardous
     end
 
+    # Returns a value from the specified command
+    #
+    # @param target_name [String] Target name of the command
+    # @param command_name [String] Packet name of the command
+    # @param parameter_name [String] Parameter name in the command
+    # @param value_type [Symbol] How the values should be converted. Must be
+    #   one of {Packet::VALUE_TYPES}
+    # @return [Varies] value
+    def get_cmd_value(target_name, command_name, parameter_name, value_type = :CONVERTED)
+      packet = System.commands.packet(target_name, command_name)
+      # Virtually support RECEIVED_TIMEFORMATTED, RECEIVED_TIMESECONDS, RECEIVED_COUNT
+      case parameter_name.to_s.upcase
+      when 'RECEIVED_TIMEFORMATTED'
+        if packet.received_time
+          return packet.received_time.formatted
+        else
+          return 'No Packet Received Time'
+        end
+      when 'RECEIVED_TIMESECONDS'
+        if packet.received_time
+          return packet.received_time.to_f
+        else
+          return 0.0
+        end
+      when 'RECEIVED_COUNT'
+        return packet.received_count
+      else
+        return packet.read(parameter_name, value_type.intern)
+      end
+    end
+
+    # Returns the time the most recent command was sent
+    #
+    # @param target_name [String] Target name of the command. If not given then
+    #    the most recent time from all commands will be returned
+    # @param command_name [String] Packet name of the command. If not given then
+    #    then most recent time from the given target will be returned.
+    # @return [Array<Target Name, Command Name, Time Seconds, Time Microseconds>]
+    def get_cmd_time(target_name = nil, command_name = nil)
+      last_command = nil
+      if target_name
+        if command_name
+          last_command = System.commands.packet(target_name, command_name)
+        else
+          System.commands.packets(target_name).each do |packet_name, command|
+            last_command = command if !last_command and command.received_time
+            if command.received_time and command.received_time > last_command.received_time
+              last_command = command
+            end
+          end
+        end
+      else
+        commands = System.commands.all
+        commands.each do |target_name, target_commands|
+          target_commands.each do |packet_name, command|
+            last_command = command if !last_command and command.received_time
+            if command.received_time and command.received_time > last_command.received_time
+              last_command = command
+            end
+          end
+        end
+      end
+
+      if last_command
+        if last_command.received_time
+          return [last_command.target_name, last_command.packet_name, last_command.received_time.tv_sec, last_command.received_time.tv_usec]
+        else
+          return [last_command.target_name, last_command.packet_name, nil, nil]
+        end
+      else
+        return [nil, nil, nil, nil]
+      end
+    end
+
     # Request a converted telemetry item from a packet.
     #
     # Accepts two different calling styles:
@@ -549,6 +626,24 @@ module Cosmos
       nil
     end
 
+    # Get the list of stale packets for a specific target or pass nil to list
+    # all stale packets
+    #
+    # @param with_limits_only [Boolean] Return only the stale packets
+    #   that have limits items and thus affect the overall limits
+    #   state of the system
+    # @param target [String] The target to find stale packets for or nil to list
+    #   all stale packets in the system
+    # @return [Array<Array<String, String>>] Array of arrays listing the target
+    #   name and packet name
+    def get_stale(with_limits_only = false, target = nil)
+      stale = []
+      System.telemetry.stale(with_limits_only, target).each do |packet|
+        stale << [packet.target_name, packet.packet_name]
+      end
+      stale
+    end
+
     # (see Cosmos::Limits#get)
     def get_limits(target_name, packet_name, item_name, limits_set = nil)
       System.limits.get(target_name, packet_name, item_name, limits_set)

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

@@ -197,7 +197,10 @@ module Cosmos
       @staleness_monitor_thread = Thread.new do
         begin
           while true
-            System.telemetry.check_stale
+            stale = System.telemetry.check_stale
+            stale.each do |packet|
+              post_limits_event(:STALE_PACKET, [packet.target_name, packet.packet_name])
+            end
             broken = @sleeper.sleep(10)
             break if broken
           end
@@ -281,8 +284,9 @@ module Cosmos
     #
     # @param event_type [Symbol] The type of limits event that occurred. Must
     #   be one of :LIMITS_SET which means the system limits set has changed,
-    #   :LIMITS_CHANGE which means an individual item has changed limits state, or
-    #   :LIMITS_SETTINGS which means an individual item has new settings
+    #   :LIMITS_CHANGE which means an individual item has changed limits state,
+    #   :LIMITS_SETTINGS which means an individual item has new settings, or
+    #   :STALE_PACKET which means a packet with limits has gone stale
     # @param event_data [Symbol|Array<String,String,String,Symbol,Symbol>]
     #   Returns the current limits set name for event_type == :LIMITS_SET.
     #   Returns an array containing the target name, packet name, item name,
@@ -354,7 +358,7 @@ module Cosmos
     # Get a limits event from the queue created by {#subscribe_limits_events}.
     #
     # Each limits event consists of an Array with two elements:
-    # \[:LIMITS_CHANGE, [target, packet, item, old state, current state]]
+    #   The Symbol name of the event and an Array of data
     #
     # @param id [Integer] The queue ID received from calling
     #   {#subscribe_limits_events}

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

@@ -320,6 +320,57 @@ module Cosmos
       # Just to avoid warning
     end
 
+    def self.graceful_kill
+      # Just to avoid warning
+    end
+
+    def self.no_gui_handle_string_output
+      if @string_output.string[-1..-1] == "\n"
+        lines_to_write = ''
+        string = @string_output.string.clone
+        @string_output.string = @string_output.string[string.length..-1]
+        string.each_line {|out_line| lines_to_write << out_line }
+        @message_log.write(lines_to_write)
+        STDOUT.print lines_to_write if STDIN.isatty # Have a console
+      end
+    end
+
+    def self.no_gui_stop_callback
+      no_gui_handle_string_output()
+      @output_sleeper.cancel
+      Cosmos.kill_thread(self, @output_thread)
+      no_gui_handle_string_output()
+    end
+
+    def self.post_options_parsed_hook(options)
+      if options.no_gui
+        begin
+          @output_sleeper = Sleeper.new
+          @string_output = StringIO.new("", "r+")
+          $stdout = @string_output
+          Logger.level = Logger::INFO
+          cts = CmdTlmServer.new(options.config_file, options.production)
+          @message_log = CmdTlmServer.message_log
+          @output_thread = Thread.new do
+            while true
+              no_gui_handle_string_output()
+              break if @output_sleeper.sleep(1)
+            end
+          end
+          cts.stop_callback = method(:no_gui_stop_callback)
+          sleep # Sleep until waked by signal
+        ensure
+          if defined? cts and cts
+            cts.stop_logging('ALL')
+            cts.stop
+          end
+        end
+        return false
+      else
+        return true
+      end
+    end
+
     # Entry point to the server application
     def self.run(option_parser = nil, options = nil)
       Cosmos.catch_fatal_exception do
@@ -333,6 +384,7 @@ module Cosmos
           options.config_file = CmdTlmServer::DEFAULT_CONFIG_FILE
           options.production = false
           options.no_prompt = false
+          options.no_gui = false
           option_parser.separator "CTS Specific Options:"
           option_parser.on("-c", "--config FILE", "Use the specified configuration file") do |arg|
             options.config_file = arg
@@ -343,6 +395,9 @@ module Cosmos
           option_parser.on("-n", "--no-prompt", "Don't prompt with Are You Sure dialog on close.") do |arg|
             options.no_prompt = true
           end
+          option_parser.on(nil, "--no-gui", "Run the server without a GUI") do |arg|
+            options.no_gui = true
+          end
         end
 
         super(option_parser, options)