openc3 5.10.0 → 5.11.0

data/lib/openc3/utilities/throttle.rb

@@ -0,0 +1,76 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 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.
+
+# Usage:
+# throttle = OpenC3::Throttle.new(50.0) # Use max 50% cpu for work
+#
+# throttle.reset # Necessary if there are large periods of idle between hard work
+# 1000.times do
+#   throttle.start
+#   # Do one iteration of cpu itensive work here
+#   # complete will sleep if necessary to not use too much CPU
+#   throttle.complete
+# end
+
+module OpenC3
+  class Throttle
+    MIN_SLEEP_SECONDS = 0.001
+    MAX_SLEEP_SECONDS = 0.100
+
+    attr_reader :reset_time
+    attr_reader :total_sleep_time
+
+    # @param max_cpu_utilization [Float] 0.0-100.0
+    def initialize(max_cpu_utilization)
+      @max_cpu_utilization = Float(max_cpu_utilization)
+      raise ArgumentError "max_cpu_utilization must be between 0.0 and 100.0" if @max_cpu_utilization > 100.0 or @max_cpu_utilization < 0.0
+      @max_cpu_utilization /= 100.0 # Normalize
+      reset()
+    end
+
+    def reset
+      @reset_time = Time.now
+      @total_sleep_time = 0
+    end
+
+    def throttle_sleep
+      return if @max_cpu_utilization >= 1.0
+      total_time = Time.now - @reset_time
+      if total_time > 0
+        cpu_utilization = 1.0 - (@total_sleep_time / total_time)
+        if cpu_utilization > @max_cpu_utilization
+          # Need to throttle
+          # max_cpu_utilization = sleep_time + total_sleep_time
+          #                       ----------------------------
+          #                       total_time
+          #
+          # (max_cpu_utilization * total_time) = sleep_time + total_sleep_time
+          #
+          # sleep_time = (max_cpu_utilization * total_time) - total_sleep_time
+          #
+          sleep_time = (@max_cpu_utilization * total_time) - @total_sleep_time
+          if sleep_time > MIN_SLEEP_SECONDS
+            sleep_time = MAX_SLEEP_SECONDS if sleep_time > MAX_SLEEP_SECONDS
+            sleep(sleep_time)
+            @total_sleep_time += sleep_time
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.10.0'
+OPENC3_VERSION = '5.11.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '10'
+    MINOR = '11'
     PATCH = '0'
     OTHER = ''
-    BUILD = '926e6a3798993710a67729b9599c5a295b210152'
+    BUILD = 'f994eee0c2fadfc67ffbf0865ba798ed11ec1f5c'
   end
-  VERSION = '5.10.0'
-  GEM_VERSION = '5.10.0'
+  VERSION = '5.11.0'
+  GEM_VERSION = '5.11.0'
 end

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.10.0",
+  "version": "5.11.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,36 +12,36 @@
   },
   "private": true,
   "dependencies": {
-    "@angular/animations": "^16.1.3",
-    "@angular/cdk": "^16.1.3",
-    "@angular/common": "^16.1.3",
-    "@angular/compiler": "^16.1.3",
-    "@angular/core": "^16.1.3",
-    "@angular/forms": "^16.1.3",
-    "@angular/material": "16.1.3",
-    "@angular/platform-browser": "^16.1.3",
-    "@angular/platform-browser-dynamic": "^16.1.3",
-    "@angular/router": "^16.1.3",
-    "@openc3/tool-common": "5.10.0",
+    "@openc3/tool-common": "5.11.0",
+    "@angular/animations": "^16.2.4",
+    "@angular/cdk": "^16.2.3",
+    "@angular/common": "^16.2.4",
+    "@angular/compiler": "^16.2.4",
+    "@angular/core": "^16.2.4",
+    "@angular/forms": "^16.2.4",
+    "@angular/material": "16.2.3",
+    "@angular/platform-browser": "^16.2.4",
+    "@angular/platform-browser-dynamic": "^16.2.4",
+    "@angular/router": "^16.2.4",
     "rxjs": "~7.8.0",
     "single-spa": ">=5.9.5",
     "single-spa-angular": "^8.1.0",
-    "tslib": "^2.6.0",
-    "zone.js": "~0.13.1"
+    "tslib": "^2.6.2",
+    "zone.js": "~0.13.3"
   },
   "devDependencies": {
-    "@angular-builders/custom-webpack": "16.0.0",
-    "@angular-devkit/build-angular": "^16.0.5",
-    "@angular/cli": "~16.1.3",
-    "@angular/compiler-cli": "^16.0.0",
+    "@angular-builders/custom-webpack": "16.0.1",
+    "@angular-devkit/build-angular": "^16.2.1",
+    "@angular/cli": "~16.2.1",
+    "@angular/compiler-cli": "^16.2.4",
     "@types/jasmine": "~4.3.0",
-    "jasmine-core": "~5.0.1",
+    "jasmine-core": "~5.1.1",
     "karma": "~6.4.0",
     "karma-chrome-launcher": "~3.2.0",
     "karma-coverage": "~2.2.0",
     "karma-jasmine": "~5.1.0",
     "karma-jasmine-html-reporter": "~2.1.0",
     "style-loader": "^3.3.1",
-    "typescript": "~5.1.6"
+    "typescript": "~5.2.2"
   }
 }