openc3 5.13.0 → 5.14.1

data/lib/openc3/system/system.rb

@@ -60,6 +60,9 @@ module OpenC3
     # The current limits set
     @@limits_set = nil
 
+    # Callbacks to call once @@instance is created
+    @@post_instance_callbacks = []
+
     # @return [Symbol] The current limits_set of the system returned from Redis
     def self.limits_set
       unless @@limits_set
@@ -72,6 +75,14 @@ module OpenC3
       @@limits_set = value.to_s.intern
     end
 
+    def self.add_post_instance_callback(callback)
+      if @@instance
+        callback.call()
+      else
+        @@post_instance_callbacks << callback
+      end
+    end
+
     def self.setup_targets(target_names, base_dir, scope:)
       # Nothing to do if there are no targets
       return if target_names.nil? or target_names.length == 0
@@ -92,6 +103,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
@@ -109,17 +132,36 @@ module OpenC3
       raise "System.instance parameters are required on first call" unless target_names and target_config_dir
 
       @@instance_mutex.synchronize do
+        return @@instance if @@instance
         @@instance ||= self.new(target_names, target_config_dir)
+        @@post_instance_callbacks.each do |callback|
+          callback.call
+        end
         return @@instance
       end
     end
 
+    # Dynamically add packets to the system instance
+    #
+    # @param dynamic_packets [Array of packets]
+    # @param cmd_or_tlm [Symbol] :COMMAND or :TELEMETRY
+    # @param affect_ids [Boolean] Whether to affect packet id lookup or not
+    def self.dynamic_update(dynamic_packets, cmd_or_tlm = :TELEMETRY, affect_ids: false)
+      dynamic_packets.each do |packet|
+        if cmd_or_tlm == :TELEMETRY
+          @@instance.telemetry.dynamic_add_packet(packet, affect_ids: affect_ids)
+        else
+          @@instance.commands.dynamic_add_packet(packet, affect_ids: affect_ids)
+        end
+      end
+    end
+
     # Create a new System object.
     #
     # @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.1'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '13'
-    PATCH = '0'
+    MINOR = '14'
+    PATCH = '1'
     OTHER = ''
-    BUILD = 'b4c2afb3edf2a5786422538ddef91f00d173855d'
+    BUILD = '902e54e502f6070c58183746a7db21a50e7b5263'
   end
-  VERSION = '5.13.0'
-  GEM_VERSION = '5.13.0'
+  VERSION = '5.14.1'
+  GEM_VERSION = '5.14.1'
 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.1",
   "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.1",
+    "@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",