openc3 5.0.6

data/lib/openc3/packets/telemetry.rb

@@ -0,0 +1,487 @@
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/packets/packet_config'
+require 'openc3/ext/telemetry' if RUBY_ENGINE == 'ruby' and !ENV['OPENC3_NO_EXT']
+
+module OpenC3
+  # 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
+  # which other classes use to access telemetry.
+  #
+  # This should not be confused with the Api module which implements the JSON
+  # API that is used by tools when accessing the Server. The Api module always
+  # provides Ruby primatives where the Telemetry class can return actual
+  # Packet or PacketItem objects. While there are some overlapping methods between
+  # the two, these are separate interfaces into the system.
+  class Telemetry
+    attr_accessor :config
+
+    LATEST_PACKET_NAME = 'LATEST'.freeze
+
+    # @param config [PacketConfig] Packet configuration to use to access the
+    #   telemetry
+    def initialize(config)
+      @config = config
+    end
+
+    # (see PacketConfig#warnings)
+    def warnings
+      return @config.warnings
+    end
+
+    # @return [Array<String>] The telemetry target names (excluding UNKNOWN)
+    def target_names
+      result = @config.telemetry.keys.sort
+      result.delete('UNKNOWN'.freeze)
+      return result
+    end
+
+    if RUBY_ENGINE != 'ruby' or ENV['OPENC3_NO_EXT']
+      # @param target_name [String] The target name
+      # @return [Hash<packet_name=>Packet>] Hash of the telemetry packets for the given
+      #   target name keyed by the packet name
+      def packets(target_name)
+        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
+
+      # @param target_name [String] The target name
+      # @param packet_name [String] The packet name. Must be a defined packet name
+      #   and not 'LATEST'.
+      # @return [Packet] The telemetry packet for the given target and packet name
+      def packet(target_name, packet_name)
+        target_packets = packets(target_name)
+        upcase_packet_name = packet_name.to_s.upcase
+        packet = target_packets[upcase_packet_name]
+        unless packet
+          upcase_target_name = target_name.to_s.upcase
+          raise "Telemetry packet '#{upcase_target_name} #{upcase_packet_name}' does not exist"
+        end
+        packet
+      end
+
+      # @param target_name (see #packet)
+      # @param packet_name [String] The packet name. 'LATEST' can also be given
+      #   to specify the last received (or defined if no packets have been
+      #   received) packet within the given target that contains the
+      #   item_name.
+      # @param item_name [String] The item name
+      # @return [Packet, PacketItem] The packet and the packet item
+      def packet_and_item(target_name, packet_name, item_name)
+        upcase_packet_name = packet_name.to_s.upcase
+        if upcase_packet_name == "LATEST".freeze
+          return_packet = newest_packet(target_name, item_name)
+        else
+          return_packet = packet(target_name, packet_name)
+        end
+        item = return_packet.get_item(item_name)
+        return [return_packet, item]
+      end
+
+      # Return a telemetry value from a packet.
+      #
+      # @param target_name (see #packet_and_item)
+      # @param packet_name (see #packet_and_item)
+      # @param item_name (see #packet_and_item)
+      # @param value_type [Symbol] How to convert the item before returning.
+      #   Must be one of {Packet::VALUE_TYPES}
+      # @return The value. :FORMATTED and :WITH_UNITS values are always returned
+      #   as Strings. :RAW values will match their data_type. :CONVERTED values
+      #   can be any type.
+      def value(target_name, packet_name, item_name, value_type = :CONVERTED)
+        packet, _ = packet_and_item(target_name, packet_name, item_name) # Handles LATEST
+        return packet.read(item_name, value_type)
+      end
+
+      # Reads the specified list of items and returns their values and limits
+      # state.
+      #
+      # @param item_array [Array<Array(String String String)>] An array
+      #   consisting of [target name, packet name, item name]
+      # @param value_types [Symbol|Array<Symbol>] How to convert the items before
+      #   returning. A single symbol of {Packet::VALUE_TYPES}
+      #   can be passed which will convert all items the same way. Or
+      #   an array of symbols can be passed to control how each item is
+      #   converted.
+      # @return [Array, Array, Array] The first array contains the item values and the
+      #   second their limits state, and the third their limits settings which includes
+      #   the red, yellow, and green (if given) limits values.
+      def values_and_limits_states(item_array, value_types = :CONVERTED)
+        items = []
+
+        # Verify item_array is a nested array
+        raise(ArgumentError, "item_array must be a nested array consisting of [[tgt,pkt,item],[tgt,pkt,item],...]") unless Array === item_array[0]
+
+        states = []
+        settings = []
+        limits_set = System.limits_set
+
+        raise(ArgumentError, "Passed #{item_array.length} items but only #{value_types.length} value types") if (Array === value_types) and item_array.length != value_types.length
+
+        value_type = value_types.intern unless Array === value_types
+        item_array.length.times do |index|
+          entry = item_array[index]
+          target_name = entry[0]
+          packet_name = entry[1]
+          item_name = entry[2]
+          value_type = value_types[index].intern if Array === value_types
+
+          packet, item = packet_and_item(target_name, packet_name, item_name) # Handles LATEST
+          items << packet.read(item_name, value_type)
+          limits = item.limits
+          states << limits.state
+          limits_values = limits.values
+          if limits_values
+            limits_settings = limits_values[limits_set]
+          else
+            limits_settings = nil
+          end
+          settings << limits_settings
+        end
+
+        return [items, states, settings]
+      end
+    end
+
+    # @param target_name (see #packet)
+    # @param packet_name (see #packet)
+    # @return [Array<PacketItem>] The telemetry items for the given target and packet name
+    def items(target_name, packet_name)
+      return packet(target_name, packet_name).sorted_items
+    end
+
+    # @param target_name (see #packet)
+    # @param packet_name (see #packet) The packet name.  LATEST is supported.
+    # @return [Array<PacketItem>] The telemetry item names for the given target and packet name
+    def item_names(target_name, packet_name)
+      if LATEST_PACKET_NAME.casecmp(packet_name).zero?
+        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 }
+      end
+      item_names
+    end
+
+    # Set a telemetry value in a packet.
+    #
+    # @param target_name (see #packet_and_item)
+    # @param packet_name (see #packet_and_item)
+    # @param item_name (see #packet_and_item)
+    # @param value The value to set in the packet
+    # @param value_type (see #tlm)
+    def set_value(target_name, packet_name, item_name, value, value_type = :CONVERTED)
+      packet, _ = packet_and_item(target_name, packet_name, item_name)
+      packet.write(item_name, value, value_type)
+    end
+
+    # @param target_name (see #packet_and_item)
+    # @param item_name (see #packet_and_item)
+    # @return [Array<Packet>] The latest (most recently arrived) packets with
+    #   the specified target and item.
+    def latest_packets(target_name, item_name)
+      target_upcase = target_name.to_s.upcase
+      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
+
+    # @param target_name (see #packet_and_item)
+    # @param item_name (see #packet_and_item)
+    # @return [Packet] The packet with the most recent timestamp that contains
+    #   the specified target and item.
+    def newest_packet(target_name, item_name)
+      # Handle LATEST_PACKET_NAME - Lookup packets for this target/item
+      packets = latest_packets(target_name, item_name)
+
+      # Find packet with newest timestamp
+      newest_packet = nil
+      newest_received_time = nil
+      packets.each do |packet|
+        received_time = packet.received_time
+        if newest_received_time
+          # See if the received time from this packet is newer.
+          # Having the >= makes this method return the last defined packet
+          # whether the timestamps are both nil or both equal.
+          if received_time and received_time >= newest_received_time
+            newest_packet = packet
+            newest_received_time = newest_packet.received_time
+          end
+        else
+          # No received time yet so take this packet
+          newest_packet = packet
+          newest_received_time = newest_packet.received_time
+        end
+      end
+      return newest_packet
+    end
+
+    # Identifies an unknown buffer of data as a defined packet and sets the
+    # packet's data to the given buffer. Identifying a packet uses the fields
+    # marked as ID_ITEM to identify if the buffer passed represents the
+    # packet defined. Incorrectly sized buffers are still processed but an
+    # error is logged.
+    #
+    # Note: This affects all subsequent requests for the packet (for example
+    # using packet) which is why the method is marked with a bang!
+    #
+    # @param packet_data [String] The binary packet data buffer
+    # @param target_names [Array<String>] List of target names to limit the search. The
+    #   default value of nil means to search all known targets.
+    # @return [Packet] The identified packet with its data set to the given
+    #   packet_data buffer. Returns nil if no packet could be identified.
+    def identify!(packet_data, target_names = nil)
+      identified_packet = identify(packet_data, target_names)
+      identified_packet.buffer = packet_data if identified_packet
+      return identified_packet
+    end
+
+    # Finds a packet from the Current Value Table that matches the given data
+    # and returns it.  Does not fill the packets buffer.  Use identify! to update the CVT.
+    #
+    # @param packet_data [String] The binary packet data buffer
+    # @param target_names [Array<String>] List of target names to limit the search. The
+    #   default value of nil means to search all known targets.
+    # @return [Packet] The identified packet, Returns nil if no packet could be identified.
+    def identify(packet_data, target_names = nil)
+      target_names = target_names() unless target_names
+
+      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
+        rescue RuntimeError
+          # No telemetry for this target
+          next
+        end
+
+        target = System.targets[target_name]
+        if target and target.tlm_unique_id_mode
+          # Iterate through the packets and see if any represent the buffer
+          target_packets.each do |packet_name, packet|
+            return packet if packet.identify?(packet_data)
+          end
+        else
+          # Do a hash lookup to quickly identify the packet
+          if target_packets.length > 0
+            packet = target_packets.first[1]
+            key = packet.read_id_values(packet_data)
+            hash = @config.tlm_id_value_hash[target_name]
+            identified_packet = hash[key]
+            identified_packet = hash['CATCHALL'.freeze] unless identified_packet
+            return identified_packet if identified_packet
+          end
+        end
+      end
+
+      return nil
+    end
+
+    def identify_and_define_packet(packet, target_names = nil)
+      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
+        identified_packet.stored = packet.stored
+        identified_packet.extra = packet.extra
+        return identified_packet
+      end
+
+      if !packet.defined?
+        begin
+          identified_packet = self.packet(packet.target_name, packet.packet_name)
+        rescue RuntimeError
+          return nil
+        end
+        identified_packet = identified_packet.clone
+        identified_packet.buffer = packet.buffer
+        identified_packet.received_time = packet.received_time
+        identified_packet.stored = packet.stored
+        identified_packet.extra = packet.extra
+        return identified_packet
+      end
+
+      return packet
+    end
+
+    # Updates the specified packet with the given packet data. Raises an error
+    # if the packet could not be found.
+    #
+    # Note: This affects all subsequent requests for the packet which is why
+    # the method is marked with a bang!
+    #
+    # @param target_name (see #packet)
+    # @param packet_name (see #packet)
+    # @param packet_data (see #identify_tlm!)
+    # @return [Packet] The packet with its data set to the given packet_data
+    #   buffer.
+    def update!(target_name, packet_name, packet_data)
+      identified_packet = packet(target_name, packet_name)
+      identified_packet.buffer = packet_data
+      return identified_packet
+    end
+
+    # Assigns a limits change callback to all telemetry packets
+    #
+    # @param limits_change_callback
+    def limits_change_callback=(limits_change_callback)
+      @config.telemetry.each do |target_name, packets|
+        packets.each do |packet_name, packet|
+          packet.limits_change_callback = limits_change_callback
+        end
+      end
+    end
+
+    # Iterates through all the telemetry packets and marks them stale if they
+    # haven't been received for over the System.staleness_seconds value.
+    #
+    # @return [Array(Packet)] Array of the stale packets
+    def check_stale
+      stale = []
+      time = Time.now.sys
+      @config.telemetry.each do |target_name, target_packets|
+        target_packets.each do |packet_name, packet|
+          if packet.received_time and (!packet.stale) and (time - packet.received_time > System.staleness_seconds)
+            packet.set_stale
+            stale << packet
+          end
+        end
+      end
+      stale
+    end
+
+    # @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] Target name or nil for all targets
+    # @return [Array(Packet)] Array of the stale packets
+    def stale(with_limits_only = false, target = nil)
+      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_name == 'UNKNOWN'
+
+        target_packets.each do |packet_name, packet|
+          if packet.stale
+            next if with_limits_only && packet.limits_items.empty?
+
+            stale << packet
+          end
+        end
+      end
+      stale
+    end
+
+    # Clears the received_count value on every packet in every target
+    def clear_counters
+      @config.telemetry.each do |target_name, target_packets|
+        target_packets.each do |packet_name, packet|
+          packet.received_count = 0
+        end
+      end
+    end
+
+    # Resets metadata on every packet in every target
+    def reset
+      @config.telemetry.each do |target_name, target_packets|
+        target_packets.each do |packet_name, packet|
+          packet.reset
+        end
+      end
+    end
+
+    # Returns the first non-hidden packet
+    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
+      end
+      nil
+    end
+
+    # Returns an array with a "TARGET_NAME PACKET_NAME ITEM_NAME" string for every item in the system
+    def all_item_strings(include_hidden = false, splash = nil)
+      strings = []
+      tnames = target_names()
+      total = tnames.length.to_f
+      tnames.each_with_index do |target_name, index|
+        if splash
+          splash.message = "Processing #{target_name} telemetry"
+          splash.progress = index / total
+        end
+
+        # Note: System only has declared target structures but telemetry may have more
+        system_target = System.targets[target_name]
+        if system_target
+          ignored_items = system_target.ignored_items
+        else
+          ignored_items = []
+        end
+
+        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
+      end
+      strings
+    end
+
+    # @return [Hash{String=>Hash{String=>Packet}}] Hash of all the telemetry
+    #   packets keyed by the target name. The value is another hash keyed by the
+    #   packet name returning the packet.
+    def all
+      @config.telemetry
+    end
+  end # class Telemetry
+end

data/lib/openc3/processors/processor.rb

@@ -0,0 +1,86 @@
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+module OpenC3
+  class Processor
+    # @return [Symbol] The value type for the processor
+    attr_reader :value_type
+
+    # @return [String] The processor name
+    attr_reader :name
+
+    # @return [Hash] The results of the most recent execution of the processor
+    attr_accessor :results
+
+    # Create a new Processor
+    # @param value_type [Symbol or String] the value type to process
+    def initialize(value_type = :CONVERTED)
+      @name = self.class.to_s.upcase
+      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
+
+    def name=(name)
+      @name = name.to_s.upcase
+    end
+
+    # Perform processing on the packet.
+    #
+    # @param packet [Packet] The packet which contains the value. This can
+    #   be useful to reach into the packet and use other values in the
+    #   conversion.
+    # @param buffer [String] The packet buffer
+    # @return The processed result
+    def call(packet, buffer)
+      raise "call method must be defined by subclass"
+    end
+
+    # @return [String] The processor class
+    def to_s
+      self.class.to_s.split('::')[-1]
+    end
+
+    # Reset any state
+    def reset
+      # By default do nothing
+    end
+
+    # Make a light weight clone of this processor. This only creates a new hash of results
+    #
+    # @return [Processor] A copy of the processor with a new hash of results
+    def clone
+      processor = super()
+      processor.results = processor.results.clone
+      processor
+    end
+    alias dup clone
+
+    # Convert to configuration file string
+    def to_config
+      "  PROCESSOR #{@name} #{self.class.name.to_s.class_name_to_filename} #{@value_type}\n"
+    end
+
+    def as_json(*a)
+      { 'name' => @name, 'class' => self.class.name, 'params' => [@value_type.to_s] }
+    end
+  end # class Processor
+end

data/lib/openc3/processors/statistics_processor.rb

@@ -0,0 +1,82 @@
+# 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.
+
+# Modified by OpenC3, Inc.
+# All changes Copyright 2022, OpenC3, Inc.
+# All Rights Reserved
+
+require 'openc3/processors/processor'
+
+module OpenC3
+  class StatisticsProcessor < Processor
+    # @return [Array] The set of samples stored by the processor
+    attr_accessor :samples
+
+    # @param item_name [String] The name of the item to gather statistics on
+    # @param samples_to_average [Integer] The number of samples to store for calculations
+    # @param value_type #See Processor::initialize
+    def initialize(item_name, samples_to_average, value_type = :CONVERTED)
+      super(value_type)
+      @item_name = item_name.to_s.upcase
+      @samples_to_average = Integer(samples_to_average)
+      reset()
+    end
+
+    # Run statistics on the item
+    #
+    # See Processor#call
+    def call(packet, buffer)
+      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)
+      @results[:MAX] = @samples.max
+      @results[:MIN] = @samples.min
+      @results[:MEAN] = mean
+      @results[:STDDEV] = stddev
+    end
+
+    # Reset any state
+    def reset
+      @samples = []
+      @results[:MAX] = nil
+      @results[:MIN] = nil
+      @results[:MEAN] = nil
+      @results[:STDDEV] = nil
+    end
+
+    # Make a light weight clone of this processor. This only creates a new hash of results
+    #
+    # @return [Processor] A copy of the processor with a new hash of results
+    def clone
+      processor = super()
+      processor.samples = processor.samples.clone
+      processor
+    end
+    alias dup clone
+
+    # Convert to configuration file string
+    def to_config
+      "  PROCESSOR #{@name} #{self.class.name.to_s.class_name_to_filename} #{@item_name} #{@samples_to_average} #{@value_type}\n"
+    end
+
+    def as_json(*a)
+      { 'name' => @name, 'class' => self.class.name, 'params' => [@item_name, @samples_to_average, @value_type.to_s] }
+    end
+  end # class StatisticsProcessor
+end