cosmos 4.5.2 → 5.0.2.pre.beta2

data/lib/cosmos/io/posix_serial_driver.rb

@@ -1,22 +1,29 @@
 # 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 'fcntl'
 require 'termios' # Requires ruby-termios gem
 require 'timeout' # For Timeout::Error
 
 module Cosmos
-
   # Serial driver for use on Posix serial ports found on UNIX based systems
   class PosixSerialDriver
-
     # (see SerialDriver#initialize)
     def initialize(port_name = '/dev/ttyS0',
                    baud_rate = 9600,
@@ -25,20 +32,20 @@ module Cosmos
                    write_timeout = 10.0,
                    read_timeout = nil,
                    flow_control = :NONE,
-                   data_bits = 8,
-                   struct = [])
+                   data_bits = 8)
 
       # Convert Baud Rate into Termios constant
       begin
         baud_rate = Object.const_get("Termios::B#{baud_rate}")
       rescue NameError
-        raise(ArgumentError, "Invalid baud rate: #{baud_rate}")
+        raise(ArgumentError, "Invalid Baud Rate, Not Defined by Termios: #{baud_rate}")
       end
 
       # Verify Parameters
-      raise(ArgumentError, "Invalid data bits: #{data_bits}") unless [5,6,7,8].include?(data_bits)
+      raise(ArgumentError, "Invalid Data Bits: #{data_bits}") unless [5, 6, 7, 8].include?(data_bits)
       raise(ArgumentError, "Invalid parity: #{parity}") if parity and !SerialDriver::VALID_PARITY.include?(parity)
-      raise(ArgumentError, "Invalid stop bits: #{stop_bits}") unless [1,2].include?(stop_bits)
+      raise(ArgumentError, "Invalid Stop Bits: #{stop_bits}") unless [1, 2].include?(stop_bits)
+
       @write_timeout = write_timeout
       @read_timeout = read_timeout
 
@@ -51,62 +58,23 @@ module Cosmos
       @handle.extend Termios
 
       # Configure the serial Port
-      tio = Termios::new_termios()
-      iflag = 0
-      iflag |= Termios::IGNPAR unless parity
-      oflag = 0
-      cflag = 0
-      cflag |= Termios::CREAD # Enable receiver
-      cflag |= Termios.const_get("CS#{data_bits}") # data bits
-      cflag |= Termios::CLOCAL # Ignore Modem Control Lines
-      cflag |= Termios::CSTOPB if stop_bits == 2
-      cflag |= Termios::PARENB if parity
-      cflag |= Termios::PARODD if parity == :ODD
-      cflag |= Termios::CRTSCTS if flow_control == :RTSCTS
-      lflag = 0
+      tio = Termios.new_termios()
+      iflags = 0
+      iflags |= Termios::IGNPAR unless parity
+      cflags = 0
+      cflags |= Termios::CREAD # Enable receiver
+      cflags |= Termios.const_get("CS#{data_bits}") # data bits
+      cflags |= Termios::CLOCAL # Ignore Modem Control Lines
+      cflags |= Termios::CSTOPB if stop_bits == 2
+      cflags |= Termios::PARENB if parity
+      cflags |= Termios::PARODD if parity == :ODD
+      cflags |= Termios::CRTSCTS if flow_control == :RTSCTS
+      tio.iflag = iflags
+      tio.oflag = 0
+      tio.cflag = cflags
+      tio.lflag = 0
       tio.cc[Termios::VTIME] = 0
       tio.cc[Termios::VMIN] = 1
-      unless struct.empty?
-        struct.each do |field, key, value|
-          case field
-          when 'iflag'
-            if value == "0"
-              iflag &= ~Termios.const_get(key)
-            else
-              iflag |= Termios.const_get(key)
-            end
-          when 'oflag'
-            if value == "0"
-              oflag &= ~Termios.const_get(key)
-            else
-              oflag |= Termios.const_get(key)
-            end
-          when 'cflag'
-            if value == "0"
-              cflag &= ~Termios.const_get(key)
-            else
-              cflag |= Termios.const_get(key)
-            end
-          when 'lflag'
-            if value == "0"
-              lflag &= ~Termios.const_get(key)
-            else
-              lflag |= Termios.const_get(key)
-            end
-          when 'cc'
-            begin
-              value = Integer(value) # Try to convert to int
-            rescue ArgumentError
-              # Ignore this error and use the string
-            end
-            tio.cc[Termios.const_get(key)] = value
-          end
-        end
-      end
-      tio.iflag = iflag
-      tio.oflag = oflag
-      tio.cflag = cflag
-      tio.lflag = lflag
       tio.ispeed = baud_rate
       tio.ospeed = baud_rate
       @handle.tcflush(Termios::TCIOFLUSH)
@@ -151,6 +119,7 @@ module Cosmos
         end
         total_bytes_sent += bytes_sent
         break if total_bytes_sent >= num_bytes_to_send
+
         data_to_send = data[total_bytes_sent..-1]
       end
     end
@@ -183,5 +152,5 @@ module Cosmos
 
       data
     end
-  end
-end
+  end # class PosixSerialDriver
+end # module Cosmos

data/lib/cosmos/io/raw_logger.rb

@@ -1,23 +1,30 @@
 # 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 'thread'
 require 'socket' # For gethostname
 require 'cosmos/config/config_parser'
 
 module Cosmos
-
   # Creates a log file of raw data for either reads or writes. Can automatically
   # cycle the log based on when the log file reaches a predefined size.
   class RawLogger
-
     # @return [String] The filename of the log
     attr_reader :filename
 
@@ -41,28 +48,24 @@ module Cosmos
     #    name of the corresponding interface
     # @param log_type [Symbol] The type of log to create. Must be :READ
     #   or :WRITE.
+    # @param log_directory [String] The directory to store the log files.
     # @param logging_enabled [Boolean] Whether to enable raw logging
     # @param cycle_size [Integer] The size in bytes before creating a new log file.
-    # @param log_directory [String] The directory to store the log files.
-    #   Passing nil will use the system default 'LOGS' directory.
     def initialize(
       log_name,
       log_type,
+      log_directory,
       logging_enabled = false,
-      cycle_size = 2000000000,
-      log_directory = nil
+      cycle_size = 2000000000
     )
       raise "log_type must be :READ or :WRITE" unless LOG_TYPES.include? log_type
+
       @log_type = log_type
       @orig_name = log_name
       @log_name = (log_name.to_s.downcase + '_raw_' + @log_type.to_s.downcase + '_' + self.object_id.to_s).freeze
+      @log_directory = log_directory
       @cycle_size = ConfigParser.handle_nil(cycle_size)
       @cycle_size = Integer(@cycle_size) if @cycle_size
-      if ConfigParser.handle_nil(log_directory)
-        @log_directory = log_directory
-      else
-        @log_directory = nil
-      end
       @mutex = Mutex.new
       @file = nil
       @filename = nil
@@ -89,6 +92,7 @@ module Cosmos
     def write(data)
       if @logging_enabled
         return if !data or data.length <= 0
+
         need_new_file = false
         @mutex.synchronize do
           if !@file or (@cycle_size and (@file.stat.size + data.length) > @cycle_size)
@@ -107,7 +111,7 @@ module Cosmos
     # not created until data is written by {#write} so this does not
     # immediately create a log file on the filesystem.
     def start
-      close_file() unless ((Time.now.sys - @start_time) < 1.0) # Prevent close/open too fast
+      close_file() unless (Time.now.sys - @start_time) < 1.0 # Prevent close/open too fast
       @mutex.synchronize { @logging_enabled = true }
     end
 
@@ -129,13 +133,10 @@ module Cosmos
     # Starting a new log file is a critical operation so the entire method is
     # wrapped with a rescue and handled with handle_critical_exception
     def start_new_file
-      @log_directory ||= System.instance.paths['LOGS']
       close_file()
       @mutex.synchronize do
-        Cosmos.set_working_dir do
-          @filename = File.join(@log_directory, File.build_timestamped_filename([@log_name], '.bin'))
-          @file = File.new(@filename, 'wb')
-        end
+        @filename = File.join(@log_directory, File.build_timestamped_filename([@log_name], '.bin'))
+        @file = File.new(@filename, 'wb')
         @start_time = Time.now.sys
         Logger.instance.info "Raw Log File Opened : #{@filename}"
       end
@@ -151,9 +152,7 @@ module Cosmos
         if @file
           begin
             @file.close unless @file.closed?
-            Cosmos.set_working_dir do
-              File.chmod(0444, @file.path) # Make file read only
-            end
+            File.chmod(0444, @file.path) # Make file read only
             Logger.instance.info "Raw Log File Closed : #{@filename}"
           rescue => err
             Logger.instance.error "Error closing #{@filename} : #{err.formatted}"
@@ -164,7 +163,5 @@ module Cosmos
         end
       end
     end
-
-  end # class RawLogger
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/io/raw_logger_pair.rb

@@ -1,39 +1,47 @@
 # 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 'cosmos/io/raw_logger'
 
 module Cosmos
-
   # Holds a read/write pair of raw loggers
   class RawLoggerPair
-
     # @return [RawLogger] The read logger
     attr_accessor :read_logger
     # @return [RawLogger] The write logger
     attr_accessor :write_logger
 
-    # @param name [String] name to be added to log file names
+    # @param name [String] name to be added to log filenames
+    # @param log_directory [String] The directory to store the log files
     # @param params [Array] raw log writer parameters or empty array
-    def initialize(name, params = [])
+    def initialize(name, log_directory, params = [])
       if params.empty?
         raw_logger_class = RawLogger
       else
         raw_logger_class = Cosmos.require_class(params[0])
       end
       if params[1]
-        @read_logger = raw_logger_class.new(name, :READ, *params[1..-1])
-        @write_logger = raw_logger_class.new(name, :WRITE, *params[1..-1])
+        @read_logger = raw_logger_class.new(name, :READ, log_directory, *params[1..-1])
+        @write_logger = raw_logger_class.new(name, :WRITE, log_directory, *params[1..-1])
       else
-        @read_logger = raw_logger_class.new(name, :READ)
-        @write_logger = raw_logger_class.new(name, :WRITE)
+        @read_logger = raw_logger_class.new(name, :READ, log_directory)
+        @write_logger = raw_logger_class.new(name, :WRITE, log_directory)
       end
     end
 
@@ -65,7 +73,5 @@ module Cosmos
       raw_logger_pair.write_logger.start if @write_logger.logging_enabled
       raw_logger_pair
     end
-
-  end # class PacketLogWriterPair
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/io/serial_driver.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 'cosmos/core_ext/kernel'
 if Kernel.is_windows?
@@ -16,13 +25,12 @@ elsif RUBY_ENGINE == 'ruby'
 end
 
 module Cosmos
-
   # A platform independent serial driver
   class SerialDriver
     EVEN = :EVEN
     ODD  = :ODD
     NONE = :NONE
-    VALID_PARITY = [EVEN,ODD,NONE]
+    VALID_PARITY = [EVEN, ODD, NONE]
 
     # @param port_name [String] Name of the serial port
     # @param baud_rate [Integer] Serial port baud rate
@@ -32,10 +40,8 @@ module Cosmos
     #   complete or nil to block
     # @param read_timeout [Float|nil] Number of seconds to wait for the read to
     #   complete or nil to block
-    # @param flow_control [Symbol] Currently supported :NONE, :RTSCTS (default :NONE)
+    # @param flow_control [Symbol] Currently supported :NONE and :RTSCTS (default :NONE)
     # @param data_bits [Integer] Number of data bits (default 8)
-    # @param struct [Array] Array of arrays of fields and values to set in the
-    #   Windows DCB or POSIX structure
     def initialize(port_name,
                    baud_rate,
                    parity = :NONE,
@@ -43,9 +49,9 @@ module Cosmos
                    write_timeout = 10.0,
                    read_timeout = nil,
                    flow_control = :NONE,
-                   data_bits = 8,
-                   struct = [])
+                   data_bits = 8)
       raise(ArgumentError, "Invalid parity: #{parity}") unless VALID_PARITY.include? parity
+
       if Kernel.is_windows?
         @driver = Win32SerialDriver.new(port_name,
                                         baud_rate,
@@ -56,8 +62,7 @@ module Cosmos
                                         0.01,
                                         1000,
                                         flow_control,
-                                        data_bits,
-                                        struct)
+                                        data_bits)
       elsif RUBY_ENGINE == 'ruby'
         @driver = PosixSerialDriver.new(port_name,
                                         baud_rate,
@@ -66,8 +71,7 @@ module Cosmos
                                         write_timeout,
                                         read_timeout,
                                         flow_control,
-                                        data_bits,
-                                        struct)
+                                        data_bits)
       else
         @driver = nil # JRuby Serial on Linux not currently supported
       end
@@ -97,5 +101,5 @@ module Cosmos
     def read_nonblock
       @driver.read_nonblock
     end
-  end
-end
+  end # class SerialDriver
+end # module Cosmos

data/lib/cosmos/io/stderr.rb

@@ -1,17 +1,25 @@
 # 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 'cosmos/io/io_multiplexer'
 
 module Cosmos
-
   # Adds STDERR to the multiplexed streams
   class Stderr < IoMultiplexer
     @@instance = nil
@@ -32,5 +40,4 @@ module Cosmos
       false
     end
   end
-
 end

data/lib/cosmos/io/stdout.rb

@@ -1,17 +1,25 @@
 # 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 'cosmos/io/io_multiplexer'
 
 module Cosmos
-
   # Adds STDOUT to the multiplexed streams
   class Stdout < IoMultiplexer
     @@instance = nil
@@ -32,5 +40,4 @@ module Cosmos
       false
     end
   end
-
 end

data/lib/cosmos/io/udp_sockets.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 'socket'
 require 'ipaddr'
@@ -17,7 +26,6 @@ Socket::IP_MULTICAST_IF = 9 unless Socket.const_defined?('IP_MULTICAST_IF')
 Socket::IP_MULTICAST_TTL = 10 unless Socket.const_defined?('IP_MULTICAST_TTL')
 
 module Cosmos
-
   class UdpReadWriteSocket
     # @param bind_port [Integer[ Port to write data out from and receive data on (0 = randomly assigned)
     # @param bind_address [String] Local address to bind to (0.0.0.0 = All local addresses)
@@ -35,7 +43,8 @@ module Cosmos
       multicast_interface_address = nil,
       ttl = 1,
       read_multicast = true,
-      write_multicast = true)
+      write_multicast = true
+    )
 
       @socket = UDPSocket.new
 
@@ -43,13 +52,13 @@ module Cosmos
       @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEADDR, 1)
 
       # Bind to local address and port - This sets recv port, write_src port, recv_address, and write_src_address
-      @socket.bind(bind_address, bind_port) if (bind_address and bind_port)
+      @socket.bind(bind_address, bind_port) if bind_address and bind_port
 
       # Default send to the specified address and port
-      @socket.connect(external_address, external_port) if (external_address and external_port)
+      @socket.connect(external_address, external_port) if external_address and external_port
 
       # Handle multicast
-      if UdpReadWriteSocket.multicast?(external_address)
+      if UdpReadWriteSocket.multicast?(external_address, external_port)
         if write_multicast
           # Basic setup set time to live
           @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, ttl.to_i)
@@ -58,7 +67,8 @@ module Cosmos
           @socket.setsockopt(
             Socket::IPPROTO_IP,
             Socket::IP_MULTICAST_IF,
-            IPAddr.new(multicast_interface_address).hton) if multicast_interface_address
+            IPAddr.new(multicast_interface_address).hton
+          ) if multicast_interface_address
         end
 
         # Receive messages sent to the multicast address
@@ -91,6 +101,7 @@ module Cosmos
         end
         total_bytes_sent += bytes_sent
         break if total_bytes_sent >= num_bytes_to_send
+
         data_to_send = data[total_bytes_sent..-1]
       end
     end
@@ -118,30 +129,17 @@ module Cosmos
     end
 
     # @param host [String] Machine name or IP address
+    # @param port [String] Port
     # @return [Boolean] Whether the hostname is multicast
-    def self.multicast?(host)
-      return false if host.nil?
-      # Look up address
-      _, _, _, *address_list = Socket.gethostbyname(host)
-      first_addr_byte = 0
-      address_list.each do |address|
-        if address.length == 4
-          first_addr_byte = address.getbyte(0)
-          break
-        end
-      end
+    def self.multicast?(host, port)
+      return false if host.nil? || port.nil?
 
-      if (first_addr_byte >= 224) && (first_addr_byte <= 239)
-        true
-      else
-        false
-      end
+      Addrinfo.udp(host, port).ipv4_multicast?
     end
   end
 
   # Creates a UDPSocket and implements a non-blocking write.
   class UdpWriteSocket < UdpReadWriteSocket
-
     # @param dest_address [String] Host to send data to
     # @param dest_port [Integer] Port to send data to
     # @param src_port [Integer[ Port to send data out from
@@ -154,7 +152,8 @@ module Cosmos
       src_port = nil,
       multicast_interface_address = nil,
       ttl = 1,
-      bind_address = "0.0.0.0")
+      bind_address = "0.0.0.0"
+    )
 
       super(
         src_port,
@@ -170,7 +169,6 @@ module Cosmos
 
   # Creates a UDPSocket and implements a non-blocking read.
   class UdpReadSocket < UdpReadWriteSocket
-
     # @param recv_port [Integer] Port to receive data on
     # @param multicast_address [String] Address to add multicast
     # @param multicast_interface_address [String] Local incoming interface to receive multicast packets on
@@ -179,7 +177,8 @@ module Cosmos
       recv_port = 0,
       multicast_address = nil,
       multicast_interface_address = nil,
-      bind_address = "0.0.0.0")
+      bind_address = "0.0.0.0"
+    )
 
       super(
         recv_port,
@@ -192,5 +191,4 @@ module Cosmos
         false)
     end
   end
-
-end # module Cosmos
+end