cosmos 4.5.0 → 5.0.2.pre.beta2

data/lib/cosmos/packets/structure.rb

@@ -1,24 +1,31 @@
 # 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 Lesser 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/packets/binary_accessor'
 require 'cosmos/packets/structure_item'
 require 'cosmos/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 module Cosmos
-
   # Maintains knowledge of a raw binary structure. Uses structure_item to
   # create individual structure items which are read and written by
   # binary_accessor.
   class Structure
-
     # @return [Symbol] Default endianness for items in the structure. One of
     #   {BinaryAccessor::ENDIANNESS}
     attr_reader :default_endianness
@@ -64,6 +71,7 @@ module Cosmos
           @default_endianness = default_endianness
           if buffer
             raise TypeError, "wrong argument type #{buffer.class} (expected String)" unless String === buffer
+
             @buffer = buffer.force_encoding(ASCII_8BIT_STRING)
           else
             @buffer = nil
@@ -79,7 +87,7 @@ module Cosmos
           @short_buffer_allowed = false
           @mutex = nil
         else
-          raise(ArgumentError, "Unrecognized endianness: #{default_endianness} - Must be :BIG_ENDIAN or :LITTLE_ENDIAN")
+          raise(ArgumentError, "Unknown endianness '#{default_endianness}', must be :BIG_ENDIAN or :LITTLE_ENDIAN")
         end
       end
 
@@ -110,6 +118,7 @@ module Cosmos
       # @return [Integer] Size of the buffer in bytes
       def length
         return @buffer.length if @buffer
+
         return 0
       end
 
@@ -207,7 +216,7 @@ module Cosmos
       # Add to the overall hash of defined items
       @items[item.name] = item
       # Update fixed size knowledge
-      @fixed_size = false if ((item.data_type != :DERIVED and item.bit_size <= 0) or (item.array_size and item.array_size <= 0))
+      @fixed_size = false if (item.data_type != :DERIVED and item.bit_size <= 0) or (item.array_size and item.array_size <= 0)
 
       # Recalculate the overall defined length of the structure
       update_needed = false
@@ -277,6 +286,7 @@ module Cosmos
     # @return (see #define)
     def append(item)
       raise ArgumentError, "Can't append an item after a variably sized item" if !@fixed_size
+
       if item.data_type == :DERIVED
         item.bit_offset = 0
       else
@@ -290,6 +300,7 @@ module Cosmos
     def get_item(name)
       item = @items[name.upcase]
       raise ArgumentError, "Unknown item: #{name}" unless item
+
       return item
     end
 
@@ -376,7 +387,7 @@ module Cosmos
     def read_all(value_type = :RAW, buffer = @buffer, top = true)
       item_array = []
       synchronize_allow_reads(top) do
-        @sorted_items.each {|item| item_array << [item.name, read_item(item, value_type, buffer)]}
+        @sorted_items.each { |item| item_array << [item.name, read_item(item, value_type, buffer)] }
       end
       return item_array
     end
@@ -395,6 +406,7 @@ module Cosmos
       synchronize_allow_reads(true) do
         @sorted_items.each do |item|
           next if ignored && ignored.include?(item.name)
+
           if (item.data_type != :BLOCK) ||
              (item.data_type == :BLOCK and value_type != :RAW and
               item.respond_to? :read_conversion and item.read_conversion)
@@ -468,6 +480,7 @@ module Cosmos
 
     def setup_mutex
       return if @mutex
+
       MUTEX.synchronize do
         @mutex ||= Mutex.new
       end
@@ -476,7 +489,7 @@ module Cosmos
     # Take the structure mutex to ensure the buffer does not change while you perform activities
     def synchronize
       setup_mutex()
-      @mutex.synchronize {|| yield}
+      @mutex.synchronize { || yield }
     end
 
     # Take the structure mutex to ensure the buffer does not change while you perform activities
@@ -527,6 +540,7 @@ module Cosmos
 
     def internal_buffer_equals(buffer)
       raise ArgumentError, "Buffer class is #{buffer.class} but must be String" unless String === buffer
+
       @buffer = buffer.dup
       @buffer.force_encoding('ASCII-8BIT'.freeze)
       if @buffer.length != @defined_length
@@ -538,7 +552,5 @@ module Cosmos
         end
       end
     end
-
   end # class Structure
-
 end # module Cosmos

data/lib/cosmos/packets/structure_item.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 Lesser 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/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
@@ -158,6 +167,7 @@ module Cosmos
 
     def data_type=(data_type)
       raise ArgumentError, "#{@name}: data_type must be a Symbol" unless Symbol === data_type
+
       case data_type
       when *DATA_TYPES
         # Valid data_type
@@ -178,7 +188,7 @@ module Cosmos
           # Ruby version < 2.4.0
           raise ArgumentError, "#{@name}: array_size must be a Fixnum" unless Fixnum === array_size
         end
-        raise ArgumentError, "#{@name}: array_size must be a multiple of bit_size" unless (@bit_size == 0 or (array_size % @bit_size == 0) or array_size < 0)
+        raise ArgumentError, "#{@name}: array_size must be a multiple of bit_size" unless @bit_size == 0 or (array_size % @bit_size == 0) or array_size < 0
         raise ArgumentError, "#{@name}: bit_size cannot be negative or zero for array items" if @bit_size <= 0
       end
       @array_size = array_size
@@ -187,6 +197,7 @@ module Cosmos
 
     def overflow=(overflow)
       raise ArgumentError, "#{@name}: overflow type must be a Symbol" unless Symbol === overflow
+
       case overflow
       when *BinaryAccessor::OVERFLOW_TYPES
         # Valid overflow
@@ -208,6 +219,7 @@ module Cosmos
       # offset.
       def <=>(other_item)
         return nil unless other_item.kind_of?(StructureItem)
+
         other_bit_offset = other_item.bit_offset
         other_bit_size = other_item.bit_size
 
@@ -294,11 +306,12 @@ module Cosmos
 
     def little_endian_bit_field?
       return false unless @endianness == :LITTLE_ENDIAN
-      return false unless (@data_type == :INT || @data_type == :UINT)
+      return false unless @data_type == :INT || @data_type == :UINT
       # If we're not byte aligned we're a bit field
       return true unless (@bit_offset % 8) == 0
       # If we don't have an even number of bytes we're a bit field
       return true unless even_byte_multiple()
+
       false
     end
 

data/lib/cosmos/packets/telemetry.rb

@@ -1,18 +1,26 @@
 # 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/packets/packet_config'
 require 'cosmos/ext/telemetry' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 module Cosmos
-
   # Telemetry uses PacketConfig to parse the command and telemetry
   # configuration files. It contains all the knowledge of which telemetry packets
   # exist in the system and how to access them. This class is the API layer
@@ -54,6 +62,7 @@ module Cosmos
         upcase_target_name = target_name.to_s.upcase
         target_packets = @config.telemetry[upcase_target_name]
         raise "Telemetry target '#{upcase_target_name}' does not exist" unless target_packets
+
         target_packets
       end
 
@@ -170,11 +179,12 @@ module Cosmos
         target_upcase = target_name.to_s.upcase
         target_latest_data = @config.latest_data[target_upcase]
         raise "Telemetry Target '#{target_upcase}' does not exist" unless target_latest_data
+
         item_names = target_latest_data.keys
       else
         tlm_packet = packet(target_name, packet_name)
         item_names = []
-        tlm_packet.sorted_items.each {|item| item_names << item.name}
+        tlm_packet.sorted_items.each { |item| item_names << item.name }
       end
       item_names
     end
@@ -200,8 +210,10 @@ module Cosmos
       item_upcase = item_name.to_s.upcase
       target_latest_data = @config.latest_data[target_upcase]
       raise "Telemetry target '#{target_upcase}' does not exist" unless target_latest_data
+
       packets = @config.latest_data[target_upcase][item_upcase]
       raise "Telemetry item '#{target_upcase} #{LATEST_PACKET_NAME} #{item_upcase}' does not exist" unless packets
+
       return packets
     end
 
@@ -267,11 +279,11 @@ module Cosmos
 
       target_names.each do |target_name|
         target_name = target_name.to_s.upcase
-        
+
         target_packets = nil
         begin
           target_packets = packets(target_name)
-          #puts target_packets.length
+          # puts target_packets.length
         rescue RuntimeError
           # No telemetry for this target
           next
@@ -303,6 +315,7 @@ module Cosmos
       if !packet.identified?
         identified_packet = identify(packet.buffer(false), target_names)
         return nil unless identified_packet
+
         identified_packet = identified_packet.clone
         identified_packet.buffer = packet.buffer
         identified_packet.received_time = packet.received_time
@@ -383,13 +396,16 @@ module Cosmos
       if target && !target_names.include?(target)
         raise "Telemetry target '#{target.upcase}' does not exist"
       end
+
       stale = []
       @config.telemetry.each do |target_name, target_packets|
-        next if (target && target != target_name)
+        next if target && target != target_name
         next if target_name == 'UNKNOWN'
+
         target_packets.each do |packet_name, packet|
           if packet.stale
-            next if (with_limits_only && packet.limits_items.empty?)
+            next if with_limits_only && packet.limits_items.empty?
+
             stale << packet
           end
         end
@@ -419,6 +435,7 @@ module Cosmos
     def first_non_hidden
       @config.telemetry.each do |target_name, target_packets|
         next if target_name == 'UNKNOWN'
+
         target_packets.each do |packet_name, packet|
           return packet unless packet.hidden
         end
@@ -448,9 +465,11 @@ module Cosmos
         packets(target_name).each do |packet_name, packet|
           # We don't audit against hidden or disabled packets
           next if !include_hidden and (packet.hidden || packet.disabled)
+
           packet.items.each_key do |item_name|
             # Skip ignored items
             next if !include_hidden and ignored_items.include? item_name
+
             strings << "#{target_name} #{packet_name} #{item_name}"
           end
         end
@@ -464,7 +483,5 @@ module Cosmos
     def all
       @config.telemetry
     end
-
   end # class Telemetry
-
 end # module Cosmos

data/lib/cosmos/processors/processor.rb

@@ -1,17 +1,24 @@
 # 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
 
 module Cosmos
-
   class Processor
-
     # @return [Symbol] The value type for the processor
     attr_reader :value_type
 
@@ -28,6 +35,7 @@ module Cosmos
       value_type = value_type.to_s.upcase.intern
       @value_type = value_type
       raise ArgumentError, "value_type must be RAW, CONVERTED, FORMATTED, or WITH_UNITS. Is #{@value_type}" unless Packet::VALUE_TYPES.include?(@value_type)
+
       @results = {}
     end
 
@@ -71,6 +79,8 @@ module Cosmos
       "  PROCESSOR #{@name} #{self.class.name.to_s.class_name_to_filename} #{@value_type}\n"
     end
 
+    def as_json
+      { 'name' => @name, 'class' => self.class.name, 'params' => [@value_type.to_s] }
+    end
   end # class Processor
-
 end # module Cosmos

data/lib/cosmos/processors/statistics_processor.rb

@@ -1,19 +1,26 @@
 # 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/processors/processor'
 
 module Cosmos
-
   class StatisticsProcessor < Processor
-
     # @return [Array] The set of samples stored by the processor
     attr_accessor :samples
 
@@ -34,6 +41,7 @@ module Cosmos
       value = packet.read(@item_name, @value_type, buffer)
       # Don't process NaN or Infinite values
       return if value.to_f.nan? || value.to_f.infinite?
+
       @samples << value
       @samples = @samples[-@samples_to_average..-1] if @samples.length > @samples_to_average
       mean, stddev = Math.stddev_sample(@samples)
@@ -67,6 +75,8 @@ module Cosmos
       "  PROCESSOR #{@name} #{self.class.name.to_s.class_name_to_filename} #{@item_name} #{@samples_to_average} #{@value_type}\n"
     end
 
+    def as_json
+      { 'name' => @name, 'class' => self.class.name, 'params' => [@item_name, @samples_to_average, @value_type.to_s] }
+    end
   end # class StatisticsProcessor
-
 end # module Cosmos

data/lib/cosmos/processors/watermark_processor.rb

@@ -1,19 +1,26 @@
 # 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/processors/processor'
 
 module Cosmos
-
   class WatermarkProcessor < Processor
-
     # @param item_name [String] The name of the item to gather statistics on
     # @param value_type #See Processor::initialize
     def initialize(item_name, value_type = :CONVERTED)
@@ -44,6 +51,8 @@ module Cosmos
       "  PROCESSOR #{@name} #{self.class.name.to_s.class_name_to_filename} #{@item_name} #{@value_type}\n"
     end
 
+    def as_json
+      { 'name' => @name, 'class' => self.class.name, 'params' => [@item_name, @value_type.to_s] }
+    end
   end # class WatermarkProcessor
-
 end # module Cosmos

data/lib/cosmos/processors.rb

@@ -1,6 +1,24 @@
 # encoding: ascii-8bit
 
-require 'cosmos/processors/processor'
-require 'cosmos/processors/statistics_processor'
-require 'cosmos/processors/watermark_processor'
-require 'cosmos/processors/new_packet_log_processor'
+# 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
+
+module Cosmos
+  autoload(:Processor, 'cosmos/processors/processor.rb')
+  autoload(:StatisticsProcessor, 'cosmos/processors/statistics_processor.rb')
+  autoload(:WatermarkProcessor, 'cosmos/processors/watermark_processor.rb')
+end