cosmos 4.5.2 → 5.0.2.pre.beta2

data/lib/cosmos/core_ext/time.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2014 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'date'
 
@@ -45,6 +54,7 @@ class Time
   SEC_PER_MINUTE = 60
   MINUTES_PER_HOUR = 60
   HOURS_PER_DAY = 24
+  NSEC_PER_SECOND = 1_000_000_000
   USEC_PER_SECOND = USEC_PER_MSEC * MSEC_PER_SECOND
   MSEC_PER_MINUTE = 60 * MSEC_PER_SECOND
   MSEC_PER_HOUR = 60 * MSEC_PER_MINUTE
@@ -88,9 +98,9 @@ class Time
   # use_utc flag.
   def sys
     if @@use_utc
-      self.dup.utc
+      self.utc
     else
-      self.dup.localtime
+      self.localtime
     end
   end
 
@@ -153,7 +163,7 @@ class Time
   # @param second [Integer]
   # @param us [Integer]
   # @return [Float] The given time as a Julian date
-  def self.mdy2julian(year, month=1, day=1, hour=0, minute=0, second=0, us=0)
+  def self.mdy2julian(year, month = 1, day = 1, hour = 0, minute = 0, second = 0, us = 0)
     # Note DateTime does not support fractions of seconds
     date_time = DateTime.new(year, month, day, hour, minute, second)
     (date_time - DATE_TIME_MJD_EPOCH).to_f + JULIAN_DATE_OF_MJD_EPOCH + us / USEC_PER_DAY_FLOAT
@@ -177,7 +187,7 @@ class Time
   # @param second [Integer]
   # @param us [Integer]
   # @return [Time] The given time as a Julian date
-  def self.mdy2mjd(year, month=1, day=1, hour=0, minute=0, second=0, us=0)
+  def self.mdy2mjd(year, month = 1, day = 1, hour = 0, minute = 0, second = 0, us = 0)
     return Time.mdy2julian(year, month, day, hour, minute, second, us) - JULIAN_DATE_OF_MJD_EPOCH
   end
 
@@ -251,6 +261,11 @@ class Time
     self.strftime(str)
   end
 
+  # @return [String] Date formatted as YYYYMMDDHHmmSSNNNNNNNNN
+  def to_timestamp
+    self.strftime("%Y%m%d%H%M%S%N")
+  end
+
   # @param time [Time]
   # @return [Float] Number of julian days since Jan 1, 2000 at noon
   def self.days_from_j2000(time)
@@ -389,9 +404,7 @@ class Time
   # @return [Float] The number of seconds from the given epoch to the given
   #   CCSDS day, milliseconds, and microseconds.
   def self.ccsds2sec(day, ms, us, sec_epoch_jd = JULIAN_DATE_OF_CCSDS_EPOCH)
-    # NOTE: We don't call ccsds2julian to avoid loss of precision
-    (day + JULIAN_DATE_OF_CCSDS_EPOCH - sec_epoch_jd +
-    ((ms.to_f + (us / 1000.0)) / MSEC_PER_DAY_FLOAT)) * SEC_PER_DAY_FLOAT
+    (self.ccsds2julian(day, ms, us) - sec_epoch_jd) * SEC_PER_DAY_FLOAT
   end
 
   # @param sec [Float] Number of seconds to convert
@@ -480,4 +493,16 @@ class Time
 
     unix_epoch_delta
   end
+
+  def to_nsec_from_epoch
+    (self.tv_sec * NSEC_PER_SECOND) + self.tv_nsec
+  end
+
+  def self.from_nsec_from_epoch(nsec_from_epoch)
+    return nil if nsec_from_epoch.nil?
+
+    seconds = nsec_from_epoch / NSEC_PER_SECOND
+    nanoseconds = nsec_from_epoch % NSEC_PER_SECOND
+    Time.at(seconds, nanoseconds, :nsec)
+  end
 end

data/lib/cosmos/core_ext.rb

@@ -1,6 +1,24 @@
 # encoding: ascii-8bit
 
+# Copyright 2022 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 Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
+
 require 'cosmos/core_ext/array'
+require 'cosmos/core_ext/binding'
 require 'cosmos/core_ext/class'
 require 'cosmos/core_ext/cosmos_io'
 require 'cosmos/core_ext/exception'

data/lib/cosmos/interfaces/interface.rb

@@ -1,19 +1,26 @@
 # encoding: ascii-8bit
 
-# Copyright 2017 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
-require 'cosmos/tools/cmd_tlm_server/api'
+require 'cosmos/api/api'
 require 'cosmos/io/raw_logger_pair'
-require 'thread'
 
 module Cosmos
-
   # Defines all the attributes and methods common to all interface classes
   # used by COSMOS.
   class Interface
@@ -22,12 +29,12 @@ module Cosmos
     # @return [String] Name of the interface
     attr_reader :name
 
+    # @return [String] State of the interface: CONNECTED, ATTEMPTING, DISCONNECTED
+    attr_accessor :state
+
     # @return [Array<String>] Array of target names associated with this interface
     attr_accessor :target_names
 
-    # @return [Thread] Thread reading from the interface
-    attr_accessor :thread
-
     # @return [Boolean] Flag indicating if the interface should be connected
     #   to on startup
     attr_accessor :connect_on_startup
@@ -84,10 +91,6 @@ module Cosmos
     #   (when used as a Router)
     attr_accessor :write_queue_size
 
-    # @return [Array<Interface>] Array of interfaces to route packets to
-    #   (when used as a Router)
-    attr_accessor :interfaces
-
     # @return [Hash<option name, option values>] Hash of options supplied to interface/router
     attr_accessor :options
 
@@ -115,18 +118,26 @@ module Cosmos
     # @return [Time] Most recent written raw data time
     attr_accessor :written_raw_data_time
 
+    # @return [Array] Config params from the INTERFACE config line
+    attr_accessor :config_params
+
+    # @return [Array<Interface>] Array of interfaces to route packets to
+    #   (when used as a BridgeRouter)
+    attr_accessor :interfaces
+
     # Initialize default attribute values
     def initialize
       @name = self.class.to_s.split("::")[-1] # Remove namespacing if present
+      @state = 'DISCONNECTED'
       @target_names = []
-      @thread = nil
       @connect_on_startup = true
       @auto_reconnect = true
       @reconnect_delay = 5.0
       @disable_disconnect = false
       @packet_log_writer_pairs = []
       @stored_packet_log_writer_pairs = []
-      @raw_logger_pair = RawLoggerPair.new(@name)
+      # TODO: How should this get the log directory
+      @raw_logger_pair = RawLoggerPair.new(@name, 'outputs/logs')
       @routers = []
       @cmd_routers = []
       @read_count = 0
@@ -137,7 +148,6 @@ module Cosmos
       @read_queue_size = 0
       @write_queue_size = 0
       @write_mutex = Mutex.new
-      @interfaces = []
       @read_allowed = true
       @write_allowed = true
       @write_raw_allowed = true
@@ -150,12 +160,14 @@ module Cosmos
       @written_raw_data = ''
       @read_raw_data_time = nil
       @written_raw_data_time = nil
+      @config_params = []
+      @interfaces = []
     end
 
     # Connects the interface to its target(s). Must be implemented by a
     # subclass.
     def connect
-      (@read_protocols | @write_protocols).each {|protocol| protocol.connect_reset}
+      (@read_protocols | @write_protocols).each { |protocol| protocol.connect_reset }
     end
 
     # Indicates if the interface is connected to its target(s) or not. Must be
@@ -167,7 +179,7 @@ module Cosmos
     # Disconnects the interface from its target(s). Must be implemented by a
     # subclass.
     def disconnect
-      (@read_protocols | @write_protocols).each {|protocol| protocol.disconnect_reset}
+      (@read_protocols | @write_protocols).each { |protocol| protocol.disconnect_reset }
     end
 
     def read_interface
@@ -182,7 +194,8 @@ module Cosmos
     # @return [Packet] Packet constructed from the data. Packet will be
     #   unidentified (nil target and packet names)
     def read
-      raise "Interface not connected for read: #{@name}" unless connected? && read_allowed?
+      raise "Interface not connected for read: #{@name}" unless connected?
+      raise "Interface not readable: #{@name}" unless read_allowed?
 
       first = true
       loop do
@@ -192,7 +205,10 @@ module Cosmos
         if !first or @read_protocols.length <= 0
           # Read data for a packet
           data = read_interface()
-          return nil unless data
+          unless data
+            Logger.info("#{@name}: read_interface requested disconnect")
+            return nil
+          end
         else
           data = ''
           first = false
@@ -200,7 +216,10 @@ module Cosmos
 
         @read_protocols.each do |protocol|
           data = protocol.read_data(data)
-          return nil if data == :DISCONNECT # Disconnect handled by thread
+          if data == :DISCONNECT
+            Logger.info("#{@name}: Protocol #{protocol.class} read_data requested disconnect")
+            return nil
+          end
           break if data == :STOP
         end
         next if data == :STOP
@@ -210,17 +229,21 @@ module Cosmos
         # Potentially modify packet
         @read_protocols.each do |protocol|
           packet = protocol.read_packet(packet)
-          return nil if packet == :DISCONNECT # Disconnect handled by thread
+          if packet == :DISCONNECT
+            Logger.info("#{@name}: Protocol #{protocol.class} read_packet requested disconnect")
+            return nil
+          end
           break if packet == :STOP
         end
         next if packet == :STOP
 
         # Return packet
         @read_count += 1
+        Logger.warn("#{@name}: Interface unexpectedly requested disconnect") unless packet
         return packet
       end
     rescue Exception => err
-      Logger.instance.error("Error reading from interface : #{@name}")
+      Logger.error("#{@name}: Error reading from interface")
       disconnect()
       raise err
     end
@@ -228,7 +251,9 @@ module Cosmos
     # Method to send a packet on the interface.
     # @param packet [Packet] The Packet to send out the interface
     def write(packet)
-      raise "Interface not connected for write: #{@name}" unless connected? && write_allowed?
+      raise "Interface not connected for write: #{@name}" unless connected?
+      raise "Interface not writable: #{@name}" unless write_allowed?
+
       _write do
         @write_count += 1
 
@@ -236,6 +261,7 @@ module Cosmos
         @write_protocols.each do |protocol|
           packet = protocol.write_packet(packet)
           if packet == :DISCONNECT
+            Logger.info("#{@name}: Protocol #{protocol.class} write_packet requested disconnect")
             disconnect()
             return
           end
@@ -248,6 +274,7 @@ module Cosmos
         @write_protocols.each do |protocol|
           data = protocol.write_data(data)
           if data == :DISCONNECT
+            Logger.info("#{@name}: Protocol #{protocol.class} write_data requested disconnect")
             disconnect()
             return
           end
@@ -261,6 +288,7 @@ module Cosmos
         @write_protocols.each do |protocol|
           packet, data = protocol.post_write_interface(packet, data)
           if packet == :DISCONNECT
+            Logger.info("#{@name}: Protocol #{protocol.class} post_write_packet requested disconnect")
             disconnect()
             return
           end
@@ -275,7 +303,9 @@ module Cosmos
     # problems.
     # @param data [String] The raw data to send out the interface
     def write_raw(data)
-      raise "Interface not connected for write_raw : #{@name}" unless connected? && write_raw_allowed?
+      raise "Interface not connected for write_raw: #{@name}" unless connected?
+      raise "Interface not write-rawable: #{@name}" unless write_raw_allowed?
+
       _write do
         write_interface(data)
       end
@@ -289,11 +319,25 @@ module Cosmos
         @write_mutex.synchronize { yield }
       end
     rescue Exception => err
-      Logger.instance.error("Error writing to interface : #{@name}")
+      Logger.error("#{@name}: Error writing to interface")
       disconnect()
       raise err
     end
 
+    def as_json
+      config = {}
+      config['name'] = @name
+      config['state'] = @state
+      config['clients'] = @num_clients
+      config['txsize'] = @write_queue_size
+      config['rxsize'] = @read_queue_size
+      config['txbytes'] = @bytes_written
+      config['rxbytes'] = @bytes_read
+      config['txcnt'] = @write_count
+      config['rxcnt'] = @read_count
+      config
+    end
+
     # @return [Boolean] Whether reading is allowed
     def read_allowed?
       @read_allowed
@@ -326,7 +370,7 @@ module Cosmos
     end
 
     # Copy settings from this interface to another interface. All instance
-    # variables are copied except for thread, num_clients, read_queue_size,
+    # variables are copied except for num_clients, read_queue_size,
     # and write_queue_size since these are all specific to the operation of the
     # interface rather than its instantiation.
     #
@@ -334,7 +378,6 @@ module Cosmos
     def copy_to(other_interface)
       other_interface.name = self.name.clone
       other_interface.target_names = self.target_names.clone
-      # The other interface has its own Thread
       other_interface.connect_on_startup = self.connect_on_startup
       other_interface.auto_reconnect = self.auto_reconnect
       other_interface.reconnect_delay = self.reconnect_delay
@@ -350,7 +393,6 @@ module Cosmos
       # num_clients is per interface so don't copy
       # read_queue_size is the number of packets in the queue so don't copy
       # write_queue_size is the number of packets in the queue so don't copy
-      other_interface.interfaces = self.interfaces.clone
       other_interface.options = self.options.clone
       other_interface.protocol_info = []
       self.protocol_info.each do |protocol_class, protocol_args, read_write|

data/lib/cosmos/interfaces/linc_interface.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2017 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'cosmos/interfaces/tcpip_client_interface'
 require 'uuidtools'
@@ -40,7 +49,7 @@ module Cosmos
       # Configuration Settings
       @handshake_enabled = ConfigParser.handle_true_false(handshake_enabled)
       @handshake_enableds = nil
-      @response_timeout  = response_timeout.to_f
+      @response_timeout = response_timeout.to_f
       @length_value_offset = Integer(length_value_offset)
       @fieldname_guid = ConfigParser.handle_nil(fieldname_guid)
       @fieldname_cmd_length = ConfigParser.handle_nil(fieldname_cmd_length)
@@ -224,12 +233,11 @@ module Cosmos
 
       if timed_out
         # Clean this command out of the array of items that require handshakes.
-        @handshake_cmds.delete_if {|hsc| hsc == handshake_cmd}
+        @handshake_cmds.delete_if { |hsc| hsc == handshake_cmd }
         raise "Timeout waiting for handshake from #{System.commands.format(packet, System.targets[packet.target_name].ignored_parameters)}"
       end
 
       process_handshake_results(handshake_cmd)
-
     rescue Exception => err
       # If anything goes wrong after successfully writing the packet to the LINC target
       # ensure that the packet gets updated in the CVT and logged to the packet log writer.
@@ -320,7 +328,7 @@ module Cosmos
 
           # Loop through all waiting commands to see if this handshake belongs to them
           this_handshake_guid = linc_handshake.get_cmd_guid(@fieldname_guid)
-          handshake_cmd_index = @handshake_cmds.index {|hsc| hsc.get_cmd_guid == this_handshake_guid}
+          handshake_cmd_index = @handshake_cmds.index { |hsc| hsc.get_cmd_guid == this_handshake_guid }
 
           # If command was waiting (ie the loop above found one), then remove it from waiters and signal it
           if handshake_cmd_index
@@ -338,7 +346,6 @@ module Cosmos
         end # of handshaking type check
       end
     end
-
   end # class LincInterface
 
   # The LincHandshakeCommand class is used only by the LincInterface.
@@ -347,7 +354,7 @@ module Cosmos
   class LincHandshakeCommand
     attr_accessor :handshake
 
-    def initialize(handshakes_mutex,cmd_guid)
+    def initialize(handshakes_mutex, cmd_guid)
       @cmd_guid = cmd_guid
       @handshakes_mutex = handshakes_mutex
       @resource = ConditionVariable.new
@@ -357,7 +364,7 @@ module Cosmos
     def wait_for_handshake(response_timeout)
       timed_out = false
 
-      @resource.wait(@handshakes_mutex,response_timeout)
+      @resource.wait(@handshakes_mutex, response_timeout)
       if @handshake
         timed_out = false
       else
@@ -404,37 +411,46 @@ module Cosmos
       # Get target name length
       target_name_length = data[0..0].unpack('C')[0]
       raise "Invalid target name length" if target_name_length == 0
+
       data = data[1..-1]
 
       # get target name
       raise "Data field too short for target name" if data.length < target_name_length
+
       # target_name = data[0..(target_name_length - 1)] # Unused
       data = data[target_name_length..-1]
 
       # get packet name length
       raise "Data field too short for packet name length" if data.length == 0
+
       packet_name_length = data[0..0].unpack('C')[0]
       raise "Invalid packet name length" if packet_name_length == 0
+
       data = data[1..-1]
 
       # get packet name
       raise "Data field too short for packet name" if data.length < packet_name_length
+
       packet_name = data[0..(packet_name_length - 1)]
       data = data[packet_name_length..-1]
 
       # get packet data length
       raise "Data field too short for packet data length" if data.length < 4
+
       packet_data_length = data[0..3].unpack('N')[0]
       raise "Invalid data length" if packet_data_length == 0
+
       data = data[4..-1]
 
       # get packet data
       raise "Data field too short for packet data" if data.length < packet_data_length
+
       packet_data = data[0..(packet_data_length - 1)]
       data = data[packet_data_length..-1]
 
       # get error source length
       raise "Data field too short for error source length" if data.length < 4
+
       error_source_length = data[0..3].unpack('N')[0]
       # note it is OK to have a 0 source length
       data = data[4..-1]

data/lib/cosmos/interfaces/protocols/burst_protocol.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2017 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'cosmos/config/config_parser'
 require 'cosmos/interfaces/protocols/protocol'
@@ -159,12 +168,12 @@ module Cosmos
       Logger.error("#{@interface ? @interface.name : ""}: Sync #{'not ' unless found}found. Discarding #{length} bytes of data.")
       if @data.length >= 0
         Logger.error(sprintf("Starting: 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X\n",
-          @data.length >= 1 ? @data.getbyte(0) : 0,
-          @data.length >= 2 ? @data.getbyte(1) : 0,
-          @data.length >= 3 ? @data.getbyte(2) : 0,
-          @data.length >= 4 ? @data.getbyte(3) : 0,
-          @data.length >= 5 ? @data.getbyte(4) : 0,
-          @data.length >= 6 ? @data.getbyte(5) : 0))
+                             @data.length >= 1 ? @data.getbyte(0) : 0,
+                             @data.length >= 2 ? @data.getbyte(1) : 0,
+                             @data.length >= 3 ? @data.getbyte(2) : 0,
+                             @data.length >= 4 ? @data.getbyte(3) : 0,
+                             @data.length >= 5 ? @data.getbyte(4) : 0,
+                             @data.length >= 6 ? @data.getbyte(5) : 0))
       end
     end
 

data/lib/cosmos/interfaces/protocols/crc_protocol.rb

@@ -1,12 +1,21 @@
 # encoding: ascii-8bit
 
-# Copyright 2017 Ball Aerospace & Technologies Corp.
+# Copyright 2022 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
+# under the terms of the GNU Affero General Public License
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This program may also be used under the terms of a commercial or
+# enterprise edition license of COSMOS if purchased from the
+# copyright holder
 
 require 'cosmos/config/config_parser'
 require 'cosmos/interfaces/protocols/protocol'
@@ -87,6 +96,7 @@ module Cosmos
 
       xor = ConfigParser.handle_true_false_nil(xor)
       raise "Invalid XOR value of '#{xor}'. Must be TRUE or FALSE." if xor && !!xor != xor
+
       reflect = ConfigParser.handle_true_false_nil(reflect) if reflect
       raise "Invalid reflect value of '#{reflect}'. Must be TRUE or FALSE." if reflect && !!reflect != reflect
 
@@ -135,7 +145,7 @@ module Cosmos
     end
 
     def read_data(data)
-      return super(data) if (data.length <= 0)
+      return super(data) if data.length <= 0
 
       crc = BinaryAccessor.read(@bit_offset, @bit_size, :UINT, data, @endianness)
       calculated_crc = @crc.calc(data[0...(@bit_offset / 8)])