openc3 5.0.9 → 5.0.10

data/lib/openc3/packets/packet.rb

@@ -21,6 +21,7 @@ require 'digest'
 require 'openc3/packets/structure'
 require 'openc3/packets/packet_item'
 require 'openc3/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['OPENC3_NO_EXT']
+require 'base64'
 
 module OpenC3
   # Adds features common to all OpenC3 packets of data to the Structure class.
@@ -85,6 +86,9 @@ module OpenC3
     # @return [Symbol] :CMD or :TLM
     attr_accessor :cmd_or_tlm
 
+    # @return [String] Base data for building packet
+    attr_reader :template
+
     # Valid format types
     VALUE_TYPES = [:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
 
@@ -98,7 +102,7 @@ module OpenC3
       # @param buffer [String] String buffer to hold the packet data
       # @param item_class [Class] Class used to instantiate items (Must be a
       #   subclass of PacketItem)
-      def initialize(target_name, packet_name, default_endianness = :BIG_ENDIAN, description = nil, buffer = nil, item_class = PacketItem)
+      def initialize(target_name = nil, packet_name = nil, default_endianness = :BIG_ENDIAN, description = nil, buffer = nil, item_class = PacketItem)
         super(default_endianness, buffer, item_class)
         # Explictly call the defined setter methods
         self.target_name = target_name
@@ -123,6 +127,7 @@ module OpenC3
         @stored = false
         @extra = nil
         @cmd_or_tlm = nil
+        @template = nil
       end
 
       # Sets the target name this packet is associated with. Unidentified packets
@@ -290,7 +295,9 @@ module OpenC3
         begin
           internal_buffer_equals(buffer)
         rescue RuntimeError
-          Logger.instance.error "#{@target_name} #{@packet_name} received with actual packet length of #{buffer.length} but defined length of #{@defined_length}"
+          if BinaryAccessor == @accessor
+            Logger.instance.error "#{@target_name} #{@packet_name} received with actual packet length of #{buffer.length} but defined length of #{@defined_length}"
+          end
         end
         @read_conversion_cache.clear if @read_conversion_cache
         process()
@@ -353,6 +360,20 @@ module OpenC3
       end
     end
 
+    # Sets the template data for the packet
+    # Template data is used as the default buffer contents if provided
+    #
+    # @param hazardous_description [String] Hazardous description of the packet
+    def template=(template)
+      if template
+        raise ArgumentError, "template must be a String but is a #{template.class}" unless String === template
+
+        @template = template.freeze
+      else
+        @template = nil
+      end
+    end
+
     # Review bit offset to look for overlapping definitions. This will allow
     # gaps in the packet, but not allow the same bits to be used for multiple
     # variables.
@@ -531,11 +552,16 @@ module OpenC3
     # @param value_type [Symbol] How to convert the item before returning it.
     #   Must be one of {VALUE_TYPES}
     # @param buffer (see Structure#read_item)
+    # @param given_raw Given raw value to optimize
     # @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 read_item(item, value_type = :CONVERTED, buffer = @buffer)
-      value = super(item, :RAW, buffer)
+    def read_item(item, value_type = :CONVERTED, buffer = @buffer, given_raw = nil)
+      if given_raw
+        value = given_raw
+      else
+        value = super(item, :RAW, buffer)
+      end
       derived_raw = false
       if item.data_type == :DERIVED && value_type == :RAW
         value_type = :CONVERTED
@@ -632,6 +658,31 @@ module OpenC3
       return value
     end
 
+    # Read a list of items in the structure
+    #
+    # @param items [StructureItem] Array of PacketItem or one of its subclasses
+    # @param value_type [Symbol] Value type to read for every item
+    # @param buffer [String] The binary buffer to read the items from
+    # @return Hash of read names and values
+    def read_items(items, value_type = :RAW, buffer = @buffer, raw_value = nil)
+      buffer = allocate_buffer_if_needed() unless buffer
+      if value_type == :RAW
+        result = super(items, value_type, buffer)
+        # Must handle DERIVED special
+        items.each do |item|
+          if item.data_type == :DERIVED
+            result[item.name] = read_item(item, value_type, buffer)
+          end
+        end
+      else
+        result = {}
+        items.each do |item|
+          result[item.name] = read_item(item, value_type, buffer)
+        end
+      end
+      return result
+    end
+
     # Write an item in the packet
     #
     # @param item [PacketItem] Instance of PacketItem or one of its subclasses
@@ -674,6 +725,24 @@ module OpenC3
       end
     end
 
+    # Write values to the buffer based on the item definitions
+    #
+    # @param items [StructureItem] Array of StructureItem or one of its subclasses
+    # @param value [Object] Array of values based on the item definitions.
+    # @param value_type [Symbol] Value type of each item to write
+    # @param buffer [String] The binary buffer to write the values to
+    def write_items(items, values, value_type = :RAW, buffer = @buffer)
+      buffer = allocate_buffer_if_needed() unless buffer
+      if value_type == :RAW
+        return super(items, values, value_type, buffer)
+      else
+        items.each_with_index do |item, index|
+          write_item(item, values[index], value_type, buffer)
+        end
+      end
+      return buffer
+    end
+
     # Read an item in the packet by name
     #
     # @param name [String] Name of the item to read
@@ -738,12 +807,17 @@ module OpenC3
     #
     # @param buffer [String] Raw buffer of binary data
     # @param skip_item_names [Array] Array of item names to skip
-    def restore_defaults(buffer = @buffer, skip_item_names = nil)
+    # @param use_templase [Boolean] Apply template before setting defaults (or not)
+    def restore_defaults(buffer = @buffer, skip_item_names = nil, use_template = true)
+      buffer = allocate_buffer_if_needed() unless buffer
       upcase_skip_item_names = skip_item_names.map(&:upcase) if skip_item_names
+      buffer.replace(@template) if @template and use_template
       @sorted_items.each do |item|
         next if RESERVED_ITEM_NAMES.include?(item.name)
 
-        write_item(item, item.default, :CONVERTED, buffer) unless skip_item_names and upcase_skip_item_names.include?(item.name)
+        unless item.default.nil?
+          write_item(item, item.default, :CONVERTED, buffer) unless skip_item_names and upcase_skip_item_names.include?(item.name)
+        end
       end
     end
 
@@ -986,6 +1060,8 @@ module OpenC3
       config['disabled'] = true if @disabled
       config['hidden'] = true if @hidden
       config['stale'] = true if @stale
+      config['accessor'] = @accessor.to_s
+      config['template'] = Base64.encode64(@template) if @template
 
       if @processors
         processors = []
@@ -1024,6 +1100,14 @@ module OpenC3
       packet.disabled = hash['disabled']
       packet.hidden = hash['hidden']
       # packet.stale is read only
+      if hash['accessor']
+        begin
+          packet.accessor = OpenC3::const_get(hash['accessor'])
+        rescue => error
+          Logger.instance.error "#{packet.target_name} #{packet.packet_name} accessor of #{hash['accessor']} could not be found due to #{error}"
+        end
+      end
+      packet.template = Base64.decode64(hash['template']) if hash['template']
       packet.meta = hash['meta']
       # Can't convert processors
       hash['items'].each do |item|
@@ -1032,6 +1116,22 @@ module OpenC3
       packet
     end
 
+    def decom
+      # Read all the RAW at once because this could be optimized by the accessor
+      json_hash = read_items(@sorted_items)
+
+      # Now read all other value types - no accessor required
+      @sorted_items.each do |item|
+        given_raw = json_hash[item.name]
+        json_hash["#{item.name}__C"] = read_item(item, :CONVERTED, @buffer, given_raw) if item.states or (item.read_conversion and item.data_type != :DERIVED)
+        json_hash["#{item.name}__F"] = read_item(item, :FORMATTED, @buffer, given_raw) if item.format_string
+        json_hash["#{item.name}__U"] = read_item(item, :WITH_UNITS, @buffer, given_raw) if item.units
+        limits_state = item.limits.state
+        json_hash["#{item.name}__L"] = limits_state if limits_state
+      end
+      json_hash
+    end
+
     protected
 
     # Performs packet specific processing on the packet.

data/lib/openc3/packets/packet_config.rb

@@ -209,7 +209,7 @@ module OpenC3
               'PARAMETER', 'ID_ITEM', 'ID_PARAMETER', 'ARRAY_ITEM', 'ARRAY_PARAMETER', 'APPEND_ITEM',\
               'APPEND_PARAMETER', 'APPEND_ID_ITEM', 'APPEND_ID_PARAMETER', 'APPEND_ARRAY_ITEM',\
               'APPEND_ARRAY_PARAMETER', 'ALLOW_SHORT', 'HAZARDOUS', 'PROCESSOR', 'META',\
-              'DISABLE_MESSAGES', 'HIDDEN', 'DISABLED'
+              'DISABLE_MESSAGES', 'HIDDEN', 'DISABLED', 'ACCESSOR', 'TEMPLATE', 'TEMPLATE_FILE'
             raise parser.error("No current packet for #{keyword}") unless @current_packet
 
             process_current_packet(parser, keyword, params)
@@ -221,7 +221,7 @@ module OpenC3
               'POLY_WRITE_CONVERSION', 'SEG_POLY_READ_CONVERSION', 'SEG_POLY_WRITE_CONVERSION',\
               'GENERIC_READ_CONVERSION_START', 'GENERIC_WRITE_CONVERSION_START', 'REQUIRED',\
               'LIMITS', 'LIMITS_RESPONSE', 'UNITS', 'FORMAT_STRING', 'DESCRIPTION',\
-              'MINIMUM_VALUE', 'MAXIMUM_VALUE', 'DEFAULT_VALUE', 'OVERFLOW', 'OVERLAP'
+              'MINIMUM_VALUE', 'MAXIMUM_VALUE', 'DEFAULT_VALUE', 'OVERFLOW', 'OVERLAP', 'KEY'
             raise parser.error("No current item for #{keyword}") unless @current_item
 
             process_current_item(parser, keyword, params)
@@ -427,7 +427,30 @@ module OpenC3
         parser.verify_num_parameters(0, 0, usage)
         @current_packet.hidden = true
         @current_packet.disabled = true
+      when 'ACCESSOR'
+        usage = "#{keyword} <Accessor class name>"
+        parser.verify_num_parameters(1, 1, usage)
+        begin
+          klass = OpenC3.require_class(params[0])
+          @current_packet.accessor = klass
+        rescue Exception => err
+          raise parser.error(err)
+        end
+
+      when 'TEMPLATE'
+        usage = "#{keyword} <Template string>"
+        parser.verify_num_parameters(1, 1, usage)
+        @current_packet.template = params[0]
 
+      when 'TEMPLATE_FILE'
+        usage = "#{keyword} <Template file path>"
+        parser.verify_num_parameters(1, 1, usage)
+
+        begin
+          @current_packet.template = parser.read_file(params[0])
+        rescue Exception => err
+          raise parser.error(err)
+        end
       end
     end
 
@@ -444,14 +467,11 @@ module OpenC3
         usage = "#{keyword} <conversion class filename> <custom parameters> ..."
         parser.verify_num_parameters(1, nil, usage)
         begin
-          # require should be performed in target.txt
-          klass = params[0].filename_to_class_name.to_class
-          raise parser.error("#{params[0].filename_to_class_name} class not found. Did you require the file in target.txt?", usage) unless klass
-
+          klass = OpenC3.require_class(params[0])
           conversion = klass.new(*params[1..(params.length - 1)])
           @current_item.public_send("#{keyword.downcase}=".to_sym, conversion)
           if klass != ProcessorConversion and (conversion.converted_type.nil? or conversion.converted_bit_size.nil?)
-            msg = "Read Conversion #{params[0].filename_to_class_name} on item #{@current_item.name} does not specify converted type or bit size"
+            msg = "Read Conversion #{params[0]} on item #{@current_item.name} does not specify converted type or bit size"
             @warnings << msg
             Logger.instance.warn @warnings[-1]
           end
@@ -600,6 +620,9 @@ module OpenC3
         parser.verify_num_parameters(0, 0, 'OVERLAP')
         @current_item.overlap = true
 
+      when 'KEY'
+        parser.verify_num_parameters(1, 1, 'KEY <key or path into data>')
+        @current_item.key = params[0]
       end
     end
 

data/lib/openc3/packets/parsers/limits_response_parser.rb

@@ -45,9 +45,7 @@ module OpenC3
 
     # @param item [PacketItem] The item the limits response should be added to
     def create_limits_response(item)
-      # require should be performed in target.txt
-      klass = @parser.parameters[0].filename_to_class_name.to_class
-      raise @parser.error("#{@parser.parameters[0].filename_to_class_name} class not found. Did you require the file in target.txt?", @usage) unless klass
+      klass = OpenC3.require_class(@parser.parameters[0])
 
       if @parser.parameters[1]
         item.limits.response = klass.new(*@parser.parameters[1..(@parser.parameters.length - 1)])

data/lib/openc3/packets/parsers/processor_parser.rb

@@ -48,8 +48,7 @@ module OpenC3
     # @param packet [Packet] The packet the processor should be added to
     def create_processor(packet)
       # require should be performed in target.txt
-      klass = @parser.parameters[1].filename_to_class_name.to_class
-      raise @parser.error("#{@parser.parameters[1].filename_to_class_name} class not found. Did you require the file in target.txt?", @usage) unless klass
+      klass = OpenC3.require_class(@parser.parameters[1])
 
       if @parser.parameters[2]
         processor = klass.new(*@parser.parameters[2..(@parser.parameters.length - 1)])

data/lib/openc3/packets/structure.rb

@@ -51,6 +51,9 @@ module OpenC3
     #   required data size is allowed.
     attr_accessor :short_buffer_allowed
 
+    # @return [Accessor] Class used to access raw data of structure from buffer
+    attr_reader :accessor
+
     if RUBY_ENGINE != 'ruby' or ENV['OPENC3_NO_EXT']
       # Used to force encoding
       ASCII_8BIT_STRING = "ASCII-8BIT".freeze
@@ -86,6 +89,7 @@ module OpenC3
           @fixed_size = true
           @short_buffer_allowed = false
           @mutex = nil
+          @accessor = BinaryAccessor
         else
           raise(ArgumentError, "Unknown endianness '#{default_endianness}', must be :BIG_ENDIAN or :LITTLE_ENDIAN")
         end
@@ -103,11 +107,7 @@ module OpenC3
         return nil if item.data_type == :DERIVED
 
         buffer = allocate_buffer_if_needed() unless buffer
-        if item.array_size
-          return BinaryAccessor.read_array(item.bit_offset, item.bit_size, item.data_type, item.array_size, buffer, item.endianness)
-        else
-          return BinaryAccessor.read(item.bit_offset, item.bit_size, item.data_type, buffer, item.endianness)
-        end
+        return @accessor.read_item(item, buffer)
       end
 
       # Get the length of the buffer used by the structure
@@ -133,6 +133,26 @@ module OpenC3
       end
     end
 
+    # Configure the accessor for this packet
+    #
+    # @param accessor [Accessor] The class to use as an accessor
+    def accessor=(accessor)
+      @accessor = accessor
+      @short_buffer_allowed = true if @accessor != BinaryAccessor
+    end
+
+    # Read a list of items in the structure
+    #
+    # @param items [StructureItem] Array of StructureItem or one of its subclasses
+    # @param value_type [Symbol] Not used. Subclasses should overload this
+    #   parameter to check whether to perform conversions on the item.
+    # @param buffer [String] The binary buffer to read the item from
+    # @return Hash of read names and values
+    def read_items(items, value_type = :RAW, buffer = @buffer)
+      buffer = allocate_buffer_if_needed() unless buffer
+      return @accessor.read_items(items, buffer)
+    end
+
     # Allocate a buffer if not available
     def allocate_buffer_if_needed
       unless @buffer
@@ -180,11 +200,8 @@ module OpenC3
     #   dependant on the item_class but by default see StructureItem.
     # @return [StrutureItem] The struture item defined
     def define_item(name, bit_offset, bit_size, data_type, array_size = nil, endianness = @default_endianness, overflow = :ERROR)
-      # Handle case-insensitive naming
-      name_upcase = name.upcase
-
       # Create the item
-      item = @item_class.new(name_upcase, bit_offset, bit_size, data_type, endianness, array_size, overflow)
+      item = @item_class.new(name, bit_offset, bit_size, data_type, endianness, array_size, overflow)
       define(item)
     end
 
@@ -348,11 +365,19 @@ module OpenC3
     # @param buffer [String] The binary buffer to write the value to
     def write_item(item, value, value_type = :RAW, buffer = @buffer)
       buffer = allocate_buffer_if_needed() unless buffer
-      if item.array_size
-        BinaryAccessor.write_array(value, item.bit_offset, item.bit_size, item.data_type, item.array_size, buffer, item.endianness, item.overflow)
-      else
-        BinaryAccessor.write(value, item.bit_offset, item.bit_size, item.data_type, buffer, item.endianness, item.overflow)
-      end
+      return @accessor.write_item(item, value, buffer)
+    end
+
+    # Write values to the buffer based on the item definitions
+    #
+    # @param items [StructureItem] Array of StructureItem or one of its subclasses
+    # @param value [Object] Array of values based on the item definitions.
+    # @param value_type [Symbol] Not used. Subclasses should overload this
+    #   parameter to check whether to perform conversions on the item.
+    # @param buffer [String] The binary buffer to write the values to
+    def write_items(items, values, value_type = :RAW, buffer = @buffer)
+      buffer = allocate_buffer_if_needed() unless buffer
+      return @accessor.write_items(items, values, buffer)
     end
 
     # Read an item in the structure by name

data/lib/openc3/packets/structure_item.rb

@@ -34,6 +34,9 @@ module OpenC3
     # @return [String] Name of the item
     attr_reader :name
 
+    # Key is used to access into nested structures during decom if applicable
+    attr_reader :key
+
     # Indicates where in the binary buffer the StructureItem exists.
     # @return [Integer] 0 based bit offset
     attr_reader :bit_offset
@@ -89,6 +92,7 @@ module OpenC3
       @structure_item_constructed = false
       # Assignment order matters due to verifications!
       self.name = name
+      self.key = name # Key defaults to name as given (not upcased)
       self.endianness = endianness
       self.data_type = data_type
       self.bit_offset = bit_offset
@@ -110,6 +114,13 @@ module OpenC3
       verify_overall() if @structure_item_constructed
     end
 
+    def key=(key)
+      raise ArgumentError, "key must be a String but is a #{name.class}" unless String === key
+      raise ArgumentError, "key must contain at least one character" if key.empty?
+
+      @key = key
+    end
+
     def endianness=(endianness)
       raise ArgumentError, "#{@name}: endianness must be a Symbol" unless Symbol === endianness
       unless BinaryAccessor::ENDIANNESS.include? endianness
@@ -297,13 +308,16 @@ module OpenC3
       endianness = hash['endianness'] ? hash['endianness'].intern : nil
       data_type = hash['data_type'] ? hash['data_type'].intern : nil
       overflow = hash['overflow'] ? hash['overflow'].intern : nil
-      StructureItem.new(hash['name'], hash['bit_offset'], hash['bit_size'], data_type,
+      si = StructureItem.new(hash['name'], hash['bit_offset'], hash['bit_size'], data_type,
         endianness, hash['array_size'], overflow)
+      si.key = hash['key'] || hash['name']
+      si
     end
 
     def as_json(*a)
       hash = {}
       hash['name'] = self.name
+      hash['key'] = self.key
       hash['bit_offset'] = self.bit_offset
       hash['bit_size'] = self.bit_size
       hash['data_type'] = self.data_type

data/lib/openc3/script/storage.rb

@@ -17,6 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 
+require 'tempfile'
 require 'net/http'
 
 module OpenC3

data/lib/openc3/utilities/local_mode.rb

@@ -306,6 +306,9 @@ module OpenC3
               puts "Removing local plugin files: #{full_folder_path}"
               File.delete(gems[0])
               File.delete(plugin_instance)
+              if Dir.empty?(File.dirname(gems[0]))
+                FileUtils.rm_rf(File.dirname(gems[0]))
+              end
               break
             end
           end

data/lib/openc3/utilities/simulated_target.rb

@@ -42,8 +42,9 @@ module OpenC3
         @tlm_packets[name].enable_method_missing
       end
 
-      # Set id values
+      # Set defaults, template, and id values
       @tlm_packets.each do |name, packet|
+        packet.restore_defaults
         ids = packet.id_items
         ids.each do |id|
           packet.public_send((id.name + '=').to_sym, id.id_value)
@@ -62,7 +63,7 @@ module OpenC3
     end
 
     def read(count_100hz, time)
-      raise "Error: read must be implemented by subclass"
+      get_pending_packets(count_100hz)
     end
 
     def tick_period_seconds

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.0.9'
+OPENC3_VERSION = '5.0.10'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '0'
-    PATCH = '9'
+    PATCH = '10'
     OTHER = ''
-    BUILD = '7c04d727e4664a45e6b1021bea58c06e2c046b10'
+    BUILD = 'a9ab663d6355e0f8d8e62ca67ea300b949f34420'
   end
-  VERSION = '5.0.9'
-  GEM_VERSION = '5.0.9'
+  VERSION = '5.0.10'
+  GEM_VERSION = '5.0.10'
 end

data/lib/openc3.rb

@@ -37,6 +37,7 @@ require 'openc3/version'
 require 'openc3/top_level'
 require 'openc3/core_ext'
 require 'openc3/utilities'
+require 'openc3/accessors'
 require 'openc3/conversions'
 require 'openc3/interfaces'
 require 'openc3/processors'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.0.9
+  version: 5.0.10
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -305,6 +305,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.9.6
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: dead_end
   requirement: !ruby/object:Gem::Requirement
@@ -578,6 +606,13 @@ files:
 - lib/cosmos.rb
 - lib/cosmosc2.rb
 - lib/openc3.rb
+- lib/openc3/accessors.rb
+- lib/openc3/accessors/accessor.rb
+- lib/openc3/accessors/binary_accessor.rb
+- lib/openc3/accessors/cbor_accessor.rb
+- lib/openc3/accessors/html_accessor.rb
+- lib/openc3/accessors/json_accessor.rb
+- lib/openc3/accessors/xml_accessor.rb
 - lib/openc3/api/api.rb
 - lib/openc3/api/authorized_api.rb
 - lib/openc3/api/cmd_api.rb
@@ -627,6 +662,7 @@ files:
 - lib/openc3/core_ext/socket.rb
 - lib/openc3/core_ext/string.rb
 - lib/openc3/core_ext/stringio.rb
+- lib/openc3/core_ext/tempfile.rb
 - lib/openc3/core_ext/time.rb
 - lib/openc3/interfaces.rb
 - lib/openc3/interfaces/interface.rb