openc3 5.13.0 → 5.14.0

data/lib/openc3/packets/packet.rb

@@ -89,6 +89,18 @@ module OpenC3
     # @return [String] Base data for building packet
     attr_reader :template
 
+    # @return [Array<Target Name, Packet Name>] Related response packet
+    attr_accessor :response
+
+    # @return [Array<Target Name, Packet Name>] Related error response packet
+    attr_accessor :error_response
+
+    # @return [Array<Target Name, Screen Name>] Related telemetry screen
+    attr_accessor :screen
+
+    # @return [Array<Array<Target Name, Packet Name, Item Name>>] Related items
+    attr_accessor :related_items
+
     # Valid format types
     VALUE_TYPES = [:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
 
@@ -297,6 +309,10 @@ module OpenC3
       @config_name
     end
 
+    def clear_config_name
+      @config_name = nil
+    end
+
     # (see Structure#buffer=)
     def buffer=(buffer)
       synchronize() do
@@ -306,7 +322,6 @@ module OpenC3
           Logger.instance.error "#{@target_name} #{@packet_name} received with actual packet length of #{buffer.length} but defined length of #{@defined_length}"
         end
         @read_conversion_cache.clear if @read_conversion_cache
-        process()
       end
     end
 
@@ -861,6 +876,33 @@ module OpenC3
       item.description = 'OpenC3 packet received count'
     end
 
+    # Reset the packet to just derived items
+    def clear_all_non_derived_items
+      @defined_length = 0
+      @defined_length_bits = 0
+      @pos_bit_size = 0
+      @neg_bit_size = 0
+      @fixed_size = true
+      @short_buffer_allowed = false
+      @id_items = nil
+      @limits_items = nil
+      new_items = {}
+      new_sorted_items = []
+      @items.each do |name, item|
+        if item.data_type == :DERIVED
+          new_items[name] = item
+        end
+      end
+      @sorted_items.each do |item|
+        if item.data_type == :DERIVED
+          new_sorted_items << item
+        end
+      end
+      @items = new_items
+      @sorted_items = new_sorted_items
+      clear_config_name()
+    end
+
     # Enable limits on an item by name
     #
     # @param name [String] Name of the item to enable limits
@@ -1008,6 +1050,13 @@ module OpenC3
       else
         config << "COMMAND #{@target_name.to_s.quote_if_necessary} #{@packet_name.to_s.quote_if_necessary} #{@default_endianness} \"#{@description}\"\n"
       end
+      if @accessor.class.to_s != 'OpenC3::BinaryAccessor'
+        config << "  ACCESSOR #{@accessor.class.to_s} #{@accessor.args.map { |a| a.to_s.quote_if_necessary }.join(" ")}\n"
+      end
+      # TODO: Add TEMPLATE_ENCODED so this can always be done inline regardless of content
+      if @template
+        config << "  TEMPLATE '#{@template}'"
+      end
       config << "  ALLOW_SHORT\n" if @short_buffer_allowed
       config << "  HAZARDOUS #{@hazardous_description.to_s.quote_if_necessary}\n" if @hazardous
       config << "  DISABLE_MESSAGES\n" if @messages_disabled
@@ -1025,7 +1074,7 @@ module OpenC3
 
       if @meta
         @meta.each do |key, values|
-          config << "  META #{key.to_s.quote_if_necessary} #{values.map { |a| a..to_s.quote_if_necessary }.join(" ")}\n"
+          config << "  META #{key.to_s.quote_if_necessary} #{values.map { |a| a.to_s.quote_if_necessary }.join(" ")}\n"
         end
       end
 
@@ -1043,6 +1092,20 @@ module OpenC3
         end
       end
 
+      if @response
+        config << "  RESPONSE #{@response[0].to_s.quote_if_necessary} #{@response[1].to_s.quote_if_necessary}"
+      end
+      if @error_response
+        config << "  ERROR_RESPONSE #{@error_response[0].to_s.quote_if_necessary} #{@error_response[1].to_s.quote_if_necessary}"
+      end
+      if @screen
+        config << "  SCREEN #{@screen[0].to_s.quote_if_necessary} #{@screen[1].to_s.quote_if_necessary}"
+      end
+      if @related_items
+        @related_items.each do |target_name, packet_name, item_name|
+          config << "  RELATED_ITEM #{target_name.to_s.quote_if_necessary} #{packet_name.to_s.quote_if_necessary} #{item_name.to_s.quote_if_necessary}"
+        end
+      end
       config
     end
 
@@ -1086,6 +1149,18 @@ module OpenC3
           items << item.as_json(*a)
         end
       end
+      if @response
+        config['response'] = @response
+      end
+      if @error_response
+        config['error_response'] = @error_response
+      end
+      if @screen
+        config['screen'] = @screen
+      end
+      if @related_items
+        config['related_items'] = @related_items
+      end
 
       config
     end
@@ -1117,6 +1192,19 @@ module OpenC3
       hash['items'].each do |item|
         packet.define(PacketItem.from_json(item))
       end
+      if hash['response']
+        packet.response = hash['response']
+      end
+      if hash['error_response']
+        packet.error_response = hash['error_response']
+      end
+      if hash['screen']
+        packet.screen = hash['screen']
+      end
+      if hash['related_items']
+        packet.related_items = hash['related_items']
+      end
+
       packet
     end
 
@@ -1144,8 +1232,6 @@ module OpenC3
       json_hash
     end
 
-    protected
-
     # Performs packet specific processing on the packet.
     # Intended to only be run once for each packet received
     def process(buffer = @buffer)
@@ -1156,6 +1242,8 @@ module OpenC3
       end
     end
 
+    protected
+
     def handle_limits_states(item, value)
       # Retrieve limits state for the given value
       limits_state = item.state_colors[value]

data/lib/openc3/packets/packet_config.rb

@@ -214,7 +214,8 @@ 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', 'ACCESSOR', 'TEMPLATE', 'TEMPLATE_FILE'
+              'DISABLE_MESSAGES', 'HIDDEN', 'DISABLED', 'ACCESSOR', 'TEMPLATE', 'TEMPLATE_FILE',\
+              'RESPONSE', 'ERROR_RESPONSE', 'SCREEN', 'RELATED_ITEM'
             raise parser.error("No current packet for #{keyword}") unless @current_packet
 
             process_current_packet(parser, keyword, params)
@@ -460,7 +461,30 @@ module OpenC3
         rescue Exception => err
           raise parser.error(err)
         end
+
+      when 'RESPONSE'
+        usage = "#{keyword} <Target Name> <Packet Name>"
+        parser.verify_num_parameters(2, 2, usage)
+        @current_packet.response = [params[0].upcase, params[1].upcase]
+
+      when 'ERROR_RESPONSE'
+        usage = "#{keyword} <Target Name> <Packet Name>"
+        parser.verify_num_parameters(2, 2, usage)
+        @current_packet.error_response = [params[0].upcase, params[1].upcase]
+
+      when 'SCREEN'
+        usage = "#{keyword} <Target Name> <Screen Name>"
+        parser.verify_num_parameters(2, 2, usage)
+        @current_packet.screen = [params[0].upcase, params[1].upcase]
+
+      when 'RELATED_ITEM'
+        usage = "#{keyword} <Target Name> <Packet Name> <Item Name>"
+        parser.verify_num_parameters(3, 3, usage)
+        @current_packet.related_items ||= []
+        @current_packet.related_items << [params[0].upcase, params[1].upcase, params[2].upcase]
+
       end
+
     end
 
     def process_current_item(parser, keyword, params)

data/lib/openc3/script/api_shared.rb

@@ -525,6 +525,17 @@ module OpenC3
     # Private implementation details
     ###########################################################################
 
+    # This must be here for custom microservices that might block.
+    # Overriden by running_script.rb for script sleep
+    def openc3_script_sleep(sleep_time = nil)
+      if sleep_time
+        sleep(sleep_time)
+      else
+        prompt("Press any key to continue...")
+      end
+      return false
+    end
+
     # Creates a string with the parameters upcased
     def _upcase(target_name, packet_name, item_name)
       "#{target_name.upcase} #{packet_name.upcase} #{item_name.upcase}"

data/lib/openc3/script/script.rb

@@ -93,17 +93,8 @@ module OpenC3
       $script_runner_api_server = nil
     end
 
-    # This isn't part of the public API because users should use wait()
-    def openc3_script_sleep(sleep_time = nil)
-      if sleep_time
-        sleep(sleep_time)
-      else
-        prompt("Press any key to continue...")
-      end
-      return false
-    end
-
     # Internal method used in scripts when encountering a hazardous command
+    # Not part of public APIs but must be implemented here
     def prompt_for_hazardous(target_name, cmd_name, hazardous_description)
       loop do
         message = "Warning: Command #{target_name} #{cmd_name} is Hazardous. "
@@ -140,6 +131,7 @@ module OpenC3
       default = ''
       if blank_or_default != true && blank_or_default != false
         question << " (default = #{blank_or_default})"
+        default = blank_or_default.to_s
         allow_blank = true
       else
         allow_blank = blank_or_default
@@ -150,7 +142,9 @@ module OpenC3
         answer.chomp!
         break if allow_blank
       end
-      answer = default if answer.empty? and !default.empty?
+      if answer.empty? and !default.empty?
+        answer = default
+      end
       return answer
     end
 
@@ -162,7 +156,7 @@ module OpenC3
 
     def message_box(string, *buttons, **options)
       print "#{string} (#{buttons.join(", ")}): "
-      print "Details: #{details}\n" if details
+      print "Details: #{details}\n" if options['details']
       gets.chomp
     end
 

data/lib/openc3/streams/tcpip_socket_stream.rb

@@ -160,5 +160,24 @@ module OpenC3
       @pipe_writer.write('.')
       @connected = false
     end
+
+    def set_option(option_name, option_values)
+      option_name_upcase = option_name.upcase
+
+      case option_name_upcase
+      when 'KEEPALIVE'
+        @write_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+        @read_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+      when 'KEEPCNT'
+        @write_socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPCNT, Integer(option_values[0]))
+        @read_socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPCNT, Integer(option_values[0]))
+      when 'KEEPIDLE'
+        @write_socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPIDLE, Integer(option_values[0]))
+        @read_socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPIDLE, Integer(option_values[0]))
+      when 'KEEPINTVL'
+        @write_socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPINTVL, Integer(option_values[0]))
+        @read_socket.setsockopt(Socket::SOL_TCP, Socket::TCP_KEEPINTVL, Integer(option_values[0]))
+      end
+    end
   end
 end

data/lib/openc3/system/system.rb

@@ -92,6 +92,18 @@ module OpenC3
               zip_file.extract(entry, path) unless File.exist?(path)
             end
           end
+
+          # Now add any modifications in targets_modified/TARGET/cmd_tlm
+          # This adds support for remembering dynamically created packets
+          # target.txt must be configured to either use all files in cmd_tlm folder (default)
+          # or have a predetermined empty file like dynamic_tlm.txt
+          bucket_path = "#{scope}/targets_modified/#{target_name}/cmd_tlm"
+          dirs, files = bucket.list_files(bucket: ENV['OPENC3_CONFIG_BUCKET'], path: bucket_path)
+          files.each do |file|
+            bucket_key = File.join(bucket_path, file['name'])
+            local_path = "#{base_dir}/targets/#{target_name}/cmd_tlm/#{file['name']}"
+            bucket.get_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: bucket_key, path: local_path)
+          end
         end
 
         # Build System from targets
@@ -119,7 +131,7 @@ module OpenC3
     # @param target_names [Array of target names]
     # @param target_config_dir Directory where target config folders are
     def initialize(target_names, target_config_dir)
-      OpenC3.add_to_search_path(target_config_dir, true)
+      OpenC3.add_to_search_path(target_config_dir, true) if target_config_dir
       @targets = {}
       @packet_config = PacketConfig.new
       @commands = Commands.new(@packet_config)

data/lib/openc3/utilities/cli_generator.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2024 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -116,6 +116,20 @@ module OpenC3
         false
       end
 
+      if @@language == 'py'
+        # If we're using Python create a requirements.txt and list it in the gemspec
+        # However, don't write over an existing file they may have already created
+        unless File.exist?("requirements.txt")
+          File.open("requirements.txt", 'w') do |file|
+            file.puts "# Python dependencies"
+          end
+        end
+        gemspec_filename = Dir['*.gemspec'][0]
+        gemspec = File.read(gemspec_filename)
+        gemspec.gsub!('plugin.txt', 'plugin.txt requirements.txt')
+        File.write(gemspec_filename, gemspec)
+      end
+
       # Add this target to plugin.txt
       File.open("plugin.txt", 'a') do |file|
         file.puts <<~DOC

data/lib/openc3/utilities/local_mode.rb

@@ -252,7 +252,7 @@ module OpenC3
                     # New install of same plugin - Leave it alone
                   end
                 else
-                  # No exiting instance.json, but we found the same gem
+                  # No existing instance.json, but we found the same gem
                   # This shouldn't happen without users using this wrong
                   # We will update
                   found = true

data/lib/openc3/utilities/store_queued.rb

@@ -0,0 +1,126 @@
+# encoding: ascii-8bit
+
+# Copyright 2024 OpenC3, Inc.
+# 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 file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/utilities/store'
+
+module OpenC3
+  class StoreQueued
+    # Variable that holds the singleton instance
+    @instance = nil
+
+    # Mutex used to ensure that only one instance is created
+    @@instance_mutex = Mutex.new
+
+    # Get the singleton instance
+    # Sets the update interval to 1 second by default
+    def self.instance(update_interval = 1) # seconds
+      return @instance if @instance
+
+      @@instance_mutex.synchronize do
+        @instance ||= self.new(update_interval)
+        return @instance
+      end
+    end
+
+    # Delegate all unknown class methods to delegate to the instance
+    def self.method_missing(message, *args, **kwargs, &)
+      self.instance.public_send(message, *args, **kwargs, &)
+    end
+
+    def initialize(update_interval)
+      @update_interval = update_interval
+      @store = store_instance()
+      # Queue to hold the store requests
+      @store_queue = Queue.new
+      # Sleeper used to delay update thread
+      @update_sleeper = Sleeper.new
+
+      at_exit() do
+        shutdown()
+      end
+
+      # Thread used to call methods on the store
+      @update_thread = OpenC3.safe_thread(self.class.to_s) do
+        store_thread_body()
+      end
+    end
+
+    def store_thread_body
+      while true
+        start_time = Time.now
+
+        unless @store_queue.empty?
+          # Pipeline the requests to redis to improve performance
+          @store.pipelined do
+            while !@store_queue.empty?
+              action = @store_queue.pop()
+              @store.method_missing(action.message, *action.args, **action.kwargs, &action.block)
+            end
+          end
+        end
+
+        # Only check whether to update at a set interval
+        run_time = Time.now - start_time
+        sleep_time = @update_interval - run_time
+        sleep_time = 0 if sleep_time < 0
+        break if @update_sleeper.sleep(sleep_time)
+      end
+    end
+
+    def shutdown
+      @update_sleeper.cancel if @update_sleeper
+      OpenC3.kill_thread(self, @update_thread) if @update_thread
+      @update_thread = nil
+      # Drain the queue before shutdown
+      unless @store_queue.empty?
+        # Pipeline the requests to redis to improve performance
+        @store.pipelined do
+          while !@store_queue.empty?
+            action = @store_queue.pop()
+            @store.method_missing(action.message, *action.args, **action.kwargs, &action.block)
+          end
+        end
+      end
+    end
+
+    # Record the message for pipelining by the thread
+    def method_missing(message, *args, **kwargs, &block)
+      o = OpenStruct.new
+      o.message = message
+      o.args = args
+      o.kwargs = kwargs
+      o.block = block
+      @store_queue.push(o)
+    end
+
+    # Returns the store we're working with
+    def store_instance
+      Store.instance
+    end
+
+    def graceful_kill
+      # Do nothing
+    end
+  end
+
+  class EphemeralStoreQueued < StoreQueued
+    def store_instance
+      EphemeralStore.instance
+    end
+  end
+end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.13.0'
+OPENC3_VERSION = '5.14.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '13'
+    MINOR = '14'
     PATCH = '0'
     OTHER = ''
-    BUILD = 'b4c2afb3edf2a5786422538ddef91f00d173855d'
+    BUILD = 'dd31e4853fa50ed08ee3100e43e75849617d0a47'
   end
-  VERSION = '5.13.0'
-  GEM_VERSION = '5.13.0'
+  VERSION = '5.14.0'
+  GEM_VERSION = '5.14.0'
 end

data/templates/plugin/plugin.gemspec

@@ -1,7 +1,7 @@
 # encoding: ascii-8bit
 
 # Create the overall gemspec
-spec = Gem::Specification.new do |s|
+Gem::Specification.new do |s|
   s.name = '<%= plugin_name %>'
   s.summary = 'OpenC3 <%= plugin_name %> plugin'
   s.description = <<-EOF
@@ -10,7 +10,7 @@ spec = Gem::Specification.new do |s|
   s.license = 'MIT'
   s.authors = ['Anonymous']
   s.email = ['name@domain.com']
-  s.homepage = 'https://github.com/OpenC3/openc3'
+  s.homepage = 'https://github.com/OpenC3/cosmos'
   s.platform = Gem::Platform::RUBY
 
   if ENV['VERSION']

data/templates/target/targets/TARGET/public/README.txt

@@ -0,0 +1 @@
+Put image files in this directory for use in Telemetry Viewer Canvas Image widgets such as CANVASIMAGE and CANVASIMAGEVALUE.

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.13.0",
+  "version": "5.14.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,23 +12,23 @@
   },
   "private": true,
   "dependencies": {
-    "@openc3/tool-common": "5.13.0",
-    "@angular/animations": "^17.0.6",
-    "@angular/cdk": "^17.0.3",
-    "@angular/common": "^17.0.6",
-    "@angular/compiler": "^17.0.6",
-    "@angular/core": "^17.0.6",
-    "@angular/forms": "^17.0.6",
-    "@angular/material": "17.0.3",
-    "@angular/platform-browser": "^17.0.6",
-    "@angular/platform-browser-dynamic": "^17.0.6",
-    "@angular/router": "^17.0.6",
-    "@astrouxds/astro-web-components": "7.19.1",
+    "@openc3/tool-common": "5.14.0",
+    "@angular/animations": "^17.0.8",
+    "@angular/cdk": "^17.0.4",
+    "@angular/common": "^17.0.8",
+    "@angular/compiler": "^17.0.8",
+    "@angular/core": "^17.0.8",
+    "@angular/forms": "^17.0.8",
+    "@angular/material": "17.0.4",
+    "@angular/platform-browser": "^17.0.8",
+    "@angular/platform-browser-dynamic": "^17.0.8",
+    "@angular/router": "^17.0.8",
+    "@astrouxds/astro-web-components": "7.20.0",
     "rxjs": "~7.8.0",
-    "single-spa": ">=6.0.0",
+    "single-spa": "5.9.5",
     "single-spa-angular": "^9.0.1",
     "tslib": "^2.6.2",
-    "zone.js": "~0.14.2"
+    "zone.js": "~0.14.3"
   },
   "devDependencies": {
     "@angular-builders/custom-webpack": "17.0.0",