openc3 5.15.1 → 5.16.0

data/lib/openc3/packets/structure.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -106,7 +106,7 @@ module OpenC3
       # @param buffer [String] The binary buffer to read the item from
       # @return Value based on the item definition. This could be a string, integer,
       #   float, or array of values.
-      def read_item(item, value_type = :RAW, buffer = @buffer)
+      def read_item(item, _value_type = :RAW, buffer = @buffer)
         buffer = allocate_buffer_if_needed() unless buffer
         return @accessor.read_item(item, buffer)
       end
@@ -139,10 +139,10 @@ module OpenC3
     # @param accessor [Accessor] The class to use as an accessor
     def accessor=(accessor)
       @accessor = accessor
-      if @accessor.enforce_short_buffer_allowed
+      # Check for Accessor because sometimes we use PythonProxy
+      if @accessor.is_a? Accessor and @accessor.enforce_short_buffer_allowed
         @short_buffer_allowed = true
       end
-      return accessor
     end
 
     # Read a list of items in the structure
@@ -152,7 +152,7 @@ module OpenC3
     #   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)
+    def read_items(items, _value_type = :RAW, buffer = @buffer)
       buffer = allocate_buffer_if_needed() unless buffer
       return @accessor.read_items(items, buffer)
     end
@@ -367,7 +367,7 @@ module OpenC3
     # @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 value to
-    def write_item(item, value, value_type = :RAW, buffer = @buffer)
+    def write_item(item, value, _value_type = :RAW, buffer = @buffer)
       buffer = allocate_buffer_if_needed() unless buffer
       return @accessor.write_item(item, value, buffer)
     end
@@ -379,7 +379,7 @@ module OpenC3
     # @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)
+    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

data/lib/openc3/packets/structure_item.rb

@@ -30,8 +30,8 @@ module OpenC3
 
     @@create_index = 0
 
-    # Valid data types adds :DERIVED to those defined by BinaryAccessor
-    DATA_TYPES = BinaryAccessor::DATA_TYPES << :DERIVED
+    # Valid data types adds :DERIVED, :ARRAY, :OBJECT to those defined by BinaryAccessor
+    DATA_TYPES = BinaryAccessor::DATA_TYPES << :DERIVED << :ARRAY << :OBJECT
 
     # Name is used by higher level classes to access the StructureItem.
     # @return [String] Name of the item
@@ -54,6 +54,8 @@ module OpenC3
     # numbers (Ruby Float). :STRING is turned into an ASCII string (Ruby
     # String). :BLOCK is turned into a binary buffer (Ruby String). :DERIVED is
     # interpreted by the subclass and can result in any type.
+    # :ARRAY is an array of unknown types
+    # :OBJECT is a Hash type object
     # @return [Symbol] {DATA_TYPES}
     attr_reader :data_type
 

data/lib/openc3/script/api_shared.rb

@@ -68,8 +68,8 @@ module OpenC3
       method = "#{method_name}(#{args.join(", ")}"
       method += ", #{orig_kwargs}" unless orig_kwargs.empty?
       method += ")"
-    rescue Exception => error
-      puts "CHECK: #{method} raised #{error.class}:#{error.message}"
+    rescue Exception => e
+      puts "CHECK: #{method} raised #{e.class}:#{e.message}"
     else
       raise(CheckError, "#{method} should have raised an exception but did not.")
     end
@@ -172,6 +172,7 @@ module OpenC3
         openc3_script_sleep()
         time_diff = Time.now.sys - start_time
         puts "WAIT: Indefinite for actual time of #{time_diff} seconds" unless quiet
+        return time_diff
 
       # wait(5) # absolute wait time
       when 1
@@ -180,6 +181,7 @@ module OpenC3
           openc3_script_sleep(args[0])
           time_diff = Time.now.sys - start_time
           puts "WAIT: #{args[0]} seconds with actual time of #{time_diff} seconds" unless quiet
+          return time_diff
         else
           raise "Non-numeric wait time specified"
         end
@@ -193,7 +195,7 @@ module OpenC3
         else
           polling_rate = DEFAULT_TLM_POLLING_RATE
         end
-        _execute_wait(target_name, packet_name, item_name, type, comparison_to_eval, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
+        return _execute_wait(target_name, packet_name, item_name, type, comparison_to_eval, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
 
       # wait('target_name', 'packet_name', 'item_name', comparison_to_eval, timeout, polling_rate) # polling_rate is optional
       when 5, 6
@@ -207,13 +209,12 @@ module OpenC3
         else
           polling_rate = DEFAULT_TLM_POLLING_RATE
         end
-        _execute_wait(target_name, packet_name, item_name, type, comparison_to_eval, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
+        return _execute_wait(target_name, packet_name, item_name, type, comparison_to_eval, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
 
       else
         # Invalid number of arguments
         raise "ERROR: Invalid number of arguments (#{args.length}) passed to wait()"
       end
-      time_diff
     end
 
     # @deprecated Use wait with type: :RAW
@@ -270,7 +271,7 @@ module OpenC3
           puts "WARN: #{wait_str} failed to be within #{range_str}" unless quiet
         end
       end
-      time
+      return success
     end
 
     # @deprecated Use wait_tolerance with type: :RAW
@@ -288,7 +289,7 @@ module OpenC3
       else
         puts "WARN: WAIT: #{exp_to_eval} is FALSE after waiting #{time_diff} seconds" unless quiet
       end
-      time_diff
+      return success
     end
 
     # Wait for the converted value of a telmetry item against a condition or for a timeout
@@ -321,7 +322,7 @@ module OpenC3
           raise CheckError, message
         end
       end
-      time_diff
+      return time_diff
     end
 
     # @deprecated use wait_check with type: :RAW
@@ -388,7 +389,7 @@ module OpenC3
           end
         end
       end
-      time_diff
+      return time_diff
     end
 
     # @deprecated Use wait_check_tolerance with type: :RAW
@@ -418,7 +419,7 @@ module OpenC3
           raise CheckError, message
         end
       end
-      time_diff
+      return time_diff
     end
     alias wait_expression_stop_on_timeout wait_check_expression
 
@@ -429,7 +430,8 @@ module OpenC3
                     polling_rate = DEFAULT_TLM_POLLING_RATE,
                     quiet: false,
                     scope: $openc3_scope, token: $openc3_token)
-      _wait_packet(false, target_name, packet_name, num_packets, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
+      success, _ = _wait_packet(false, target_name, packet_name, num_packets, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
+      return success
     end
 
     # Wait for a telemetry packet to be received a certain number of times or timeout and raise an error
@@ -440,7 +442,8 @@ module OpenC3
                           polling_rate = DEFAULT_TLM_POLLING_RATE,
                           quiet: false,
                           scope: $openc3_scope, token: $openc3_token)
-      _wait_packet(true, target_name, packet_name, num_packets, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
+      _, time_diff = _wait_packet(true, target_name, packet_name, num_packets, timeout, polling_rate, quiet: quiet, scope: scope, token: token)
+      return time_diff
     end
 
     def disable_instrumentation
@@ -491,8 +494,8 @@ module OpenC3
       cached = false
       begin
         Kernel::load(procedure_name)
-      rescue LoadError => error
-        raise LoadError, "Error loading -- #{procedure_name}\n#{error.message}"
+      rescue LoadError => e
+        raise LoadError, "Error loading -- #{procedure_name}\n#{e.message}"
       end
       # Return whether we had to load and instrument this file, i.e. it was not cached
       !cached
@@ -645,7 +648,7 @@ module OpenC3
           puts "WARN: #{message}" unless quiet
         end
       end
-      time_diff
+      return success, time_diff
     end
 
     def _execute_wait(target_name, packet_name, item_name, value_type, comparison_to_eval, timeout, polling_rate, quiet: false, scope: $openc3_scope, token: $openc3_token)
@@ -660,6 +663,7 @@ module OpenC3
       else
         puts "WARN: #{wait_str} failed #{value_str}" unless quiet
       end
+      return success
     end
 
     def _wait_tolerance_process_args(args)
@@ -805,13 +809,13 @@ module OpenC3
       end
 
       return false, value
-    rescue NameError => error
-      if error.message =~ /uninitialized constant OpenC3::ApiShared::(\w+)/
+    rescue NameError => e
+      if e.message =~ /uninitialized constant OpenC3::ApiShared::(\w+)/
         new_error = NameError.new("Uninitialized constant #{$1}. Did you mean '#{$1}' as a string?")
-        new_error.set_backtrace(error.backtrace)
+        new_error.set_backtrace(e.backtrace)
         raise new_error
       else
-        raise error
+        raise e
       end
     end
 
@@ -860,19 +864,19 @@ module OpenC3
           if eval(exp_to_eval, context)
             return true
           else
-            return nil
+            return false
           end
         end
       end
 
-      return nil
-    rescue NameError => error
-      if error.message =~ /uninitialized constant OpenC3::ApiShared::(\w+)/
+      return false
+    rescue NameError => e
+      if e.message =~ /uninitialized constant OpenC3::ApiShared::(\w+)/
         new_error = NameError.new("Uninitialized constant #{$1}. Did you mean '#{$1}' as a string?")
-        new_error.set_backtrace(error.backtrace)
+        new_error.set_backtrace(e.backtrace)
         raise new_error
       else
-        raise error
+        raise e
       end
     end
 
@@ -893,13 +897,13 @@ module OpenC3
           raise CheckError, message
         end
       end
-    rescue NameError => error
-      if error.message =~ /uninitialized constant OpenC3::ApiShared::(\w+)/
+    rescue NameError => e
+      if e.message =~ /uninitialized constant OpenC3::ApiShared::(\w+)/
         new_error = NameError.new("Uninitialized constant #{$1}. Did you mean '#{$1}' as a string?")
-        new_error.set_backtrace(error.backtrace)
+        new_error.set_backtrace(e.backtrace)
         raise new_error
       else
-        raise error
+        raise e
       end
     end
   end

data/lib/openc3/script/plugins.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
@@ -38,8 +38,8 @@ module OpenC3
             return JSON.parse(response.body, allow_nan: true, create_additions: true)
           end
         end
-      rescue => error
-        raise "get_plugin_list failed due to #{error.formatted}\nResponse:\n#{response_body}"
+      rescue => e
+        raise "get_plugin_list failed due to #{e.formatted}\nURI:#{uri}\nResponse:\n#{response_body}"
       end
     end
 
@@ -61,8 +61,8 @@ module OpenC3
             return JSON.parse(response.body, allow_nan: true, create_additions: true)
           end
         end
-      rescue => error
-        raise "get_plugin failed due to #{error.formatted}\nResponse:\n#{response_body}"
+      rescue => e
+        raise "get_plugin failed due to #{e.formatted}\nURI:#{uri}\nResponse:\n#{response_body}"
       end
     end
 
@@ -95,8 +95,8 @@ module OpenC3
             end
           end
         end
-      rescue => error
-        raise "plugin_install_phase1 failed due to #{error.formatted}\nResponse:\n#{response_body}"
+      rescue => e
+        raise "plugin_install_phase1 failed due to #{e.formatted}\nURI:#{uri}\nResponse:\n#{response_body}"
       end
     end
 
@@ -129,8 +129,8 @@ module OpenC3
             return response_body.remove_quotes
           end
         end
-      rescue => error
-        raise "plugin_install_phase2 failed due to #{error.formatted}\nResponse:\n#{response_body}"
+      rescue => e
+        raise "plugin_install_phase2 failed due to #{e.formatted}\nURI:#{uri}\nResponse:\n#{response_body}"
       end
     end
 
@@ -154,8 +154,8 @@ module OpenC3
             return response_body.remove_quotes
           end
         end
-      rescue => error
-        raise "plugin_uninstall failed due to #{error.formatted}\nResponse:\n#{response_body}"
+      rescue => e
+        raise "plugin_uninstall failed due to #{e.formatted}\nURI:#{uri}\nResponse:\n#{response_body}"
       end
     end
 
@@ -177,8 +177,8 @@ module OpenC3
             return JSON.parse(response.body, allow_nan: true, create_additions: true)
           end
         end
-      rescue => error
-        raise "plugin_status failed due to #{error.formatted}\nResponse:\n#{response_body}"
+      rescue => e
+        raise "plugin_status failed due to #{e.formatted}\nURI:#{uri}\nResponse:\n#{response_body}"
       end
     end
 

data/lib/openc3/script/storage.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -175,9 +175,8 @@ module OpenC3
       if $openc3_in_cluster
         case ENV['OPENC3_CLOUD']
         when 'local'
-          bucket_url = ENV["OPENC3_BUCKET_URL"] || "openc3-minio:9000"
-          # TODO: Bucket schema for http vs https
-          URI.parse("http://#{bucket_url}#{url}")
+          bucket_url = ENV["OPENC3_BUCKET_URL"] || "http://openc3-minio:9000"
+          URI.parse("#{bucket_url}#{url}")
         when 'aws'
           URI.parse("https://s3.#{ENV['AWS_REGION']}.amazonaws.com" + url)
         when 'gcp'

data/lib/openc3/script/web_socket_api.rb

@@ -215,6 +215,16 @@ module OpenC3
     end
   end
 
+  # All Scripts WebSocket
+  class AllScriptsWebSocketApi < ScriptWebSocketApi
+    def initialize(url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
+      @identifier = {
+        channel: "AllScriptsChannel",
+      }
+      super(url: url, write_timeout: write_timeout, read_timeout: read_timeout, connect_timeout: connect_timeout, authentication: authentication, scope: scope)
+    end
+  end
+
   # Log Messages WebSocket
   class MessagesWebSocketApi < CmdTlmWebSocketApi
     def initialize(history_count: 0, start_time: nil, end_time: nil, level: nil, types: nil, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.15.1'
+OPENC3_VERSION = '5.16.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '15'
-    PATCH = '1'
+    MINOR = '16'
+    PATCH = '0'
     OTHER = ''
-    BUILD = 'e825c03f698ac51170218e43cec3c3cecefe58fa'
+    BUILD = 'bbe7a70f0e976ed4ecb939a83633e4dee9a094bd'
   end
-  VERSION = '5.15.1'
-  GEM_VERSION = '5.15.1'
+  VERSION = '5.16.0'
+  GEM_VERSION = '5.16.0'
 end

data/templates/target/targets/TARGET/lib/target.py

@@ -4,6 +4,8 @@
 #   <%= target_object %>.utility()
 # For more information see the OpenC3 scripting guide
 
+from openc3.script import *
+
 class <%= target_class %>:
     def utility(self):
         pass

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.15.1",
+  "version": "5.16.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,18 +12,18 @@
   },
   "private": true,
   "dependencies": {
-    "@openc3/tool-common": "5.15.1",
+    "@openc3/tool-common": "5.16.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/material": "17.3.6",
     "@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",
+    "@astrouxds/astro-web-components": "7.22.0",
     "rxjs": "~7.8.0",
     "single-spa": "5.9.5",
     "single-spa-angular": "^9.0.1",
@@ -31,9 +31,9 @@
     "zone.js": "~0.14.3"
   },
   "devDependencies": {
-    "@angular-builders/custom-webpack": "17.0.0",
+    "@angular-builders/custom-webpack": "17.0.2",
     "@angular-devkit/build-angular": "^17.0.6",
-    "@angular/cli": "~17.0.6",
+    "@angular/cli": "~17.3.6",
     "@angular/compiler-cli": "^17.0.6",
     "@types/jasmine": "~5.1.4",
     "jasmine-core": "~5.1.1",
@@ -42,7 +42,7 @@
     "karma-coverage": "~2.2.0",
     "karma-jasmine": "~5.1.0",
     "karma-jasmine-html-reporter": "~2.1.0",
-    "style-loader": "^3.3.1",
-    "typescript": "~5.3.3"
+    "style-loader": "^4.0.0",
+    "typescript": "~5.4.5"
   }
 }

data/templates/tool_react/package.json

@@ -41,11 +41,11 @@
     "jest": "^29.7.0",
     "jest-cli": "^29.7.0",
     "prettier": "^3.1.1",
-    "pretty-quick": "^3.1.1",
+    "pretty-quick": "^4.0.0",
     "webpack": "^5.89.0",
     "webpack-cli": "^5.1.4",
     "webpack-config-single-spa-react": "^4.0.5",
-    "webpack-dev-server": "^4.0.0",
+    "webpack-dev-server": "^5.0.4",
     "webpack-merge": "^5.10.0"
   }
 }