openc3 6.4.2 → 6.5.0

data/lib/openc3/models/scope_model.rb

@@ -20,17 +20,17 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
-require 'openc3/version'
-require 'openc3/models/model'
-require 'openc3/models/plugin_model'
-require 'openc3/models/microservice_model'
-require 'openc3/models/setting_model'
-require 'openc3/models/trigger_group_model'
-require 'openc3/topics/system_events_topic'
+require "openc3/version"
+require "openc3/models/model"
+require "openc3/models/plugin_model"
+require "openc3/models/microservice_model"
+require "openc3/models/setting_model"
+require "openc3/models/trigger_group_model"
+require "openc3/topics/system_events_topic"
 
 begin
-  require 'openc3-enterprise/models/cmd_authority_model'
-  require 'openc3-enterprise/models/critical_cmd_model'
+  require "openc3-enterprise/models/cmd_authority_model"
+  require "openc3-enterprise/models/critical_cmd_model"
   module OpenC3
     class ScopeModel < Model
       ENTERPRISE = true
@@ -46,7 +46,7 @@ end
 
 module OpenC3
   class ScopeModel < Model
-    PRIMARY_KEY = 'openc3_scopes'
+    PRIMARY_KEY = "openc3_scopes"
 
     attr_accessor :children
     attr_accessor :text_log_cycle_time
@@ -76,17 +76,17 @@ module OpenC3
     end
 
     def self.from_json(json, scope: nil)
-      json = JSON.parse(json, :allow_nan => true, :create_additions => true) if String === json
+      json = JSON.parse(json, allow_nan: true, create_additions: true) if String === json
       raise "json data is nil" if json.nil?
-      self.new(**json.transform_keys(&:to_sym))
+      new(**json.transform_keys(&:to_sym))
     end
 
     def self.get_model(name:, scope: nil)
       json = get(name: name)
       if json
-        return from_json(json)
+        from_json(json)
       else
-        return nil
+        nil
       end
     end
 
@@ -99,8 +99,7 @@ module OpenC3
       command_authority: false,
       critical_commanding: "OFF",
       shard: 0,
-      updated_at: nil
-    )
+      updated_at: nil)
       super(
         PRIMARY_KEY,
         name: name,
@@ -117,7 +116,7 @@ module OpenC3
       @command_authority = command_authority
       @critical_commanding = critical_commanding.to_s.upcase
       @critical_commanding = "OFF" if @critical_commanding.length == 0
-      if not ["OFF", "NORMAL", "ALL"].include?(@critical_commanding)
+      if !["OFF", "NORMAL", "ALL"].include?(@critical_commanding)
         raise "Invalid value for critical_commanding: #{@critical_commanding}"
       end
       @shard = shard.to_i # to_i to handle nil
@@ -126,7 +125,7 @@ module OpenC3
 
     def create(update: false, force: false, queued: false)
       # Ensure there are no "." in the scope name - prevents gems accidentally becoming scope names
-      raise "Invalid scope name: #{@name}" if @name !~ /^[a-zA-Z0-9_-]+$/
+      raise "Invalid scope name: #{@name}" if !/^[a-zA-Z0-9_-]+$/.match?(@name)
       @name = @name.upcase
       @scope = @name # Ensure @scope matches @name
       # Ensure the various cycle and retain times are integers
@@ -135,7 +134,7 @@ module OpenC3
       @text_log_retain_time = @text_log_retain_time.to_i if @text_log_retain_time
       @tool_log_retain_time = @tool_log_retain_time.to_i if @tool_log_retain_time
       @cleanup_poll_time = @cleanup_poll_time.to_i
-      super(update: update, force: force, queued: queued)
+      super
 
       if ENTERPRISE
         # If we're updating the scope and disabling command_authority
@@ -157,50 +156,49 @@ module OpenC3
         end
       end
 
-      SystemEventsTopic.write(:scope, as_json())
+      SystemEventsTopic.write(:scope, as_json)
     end
 
     def destroy
-      if @name != 'DEFAULT'
+      if @name != "DEFAULT"
         # Remove all the plugins for this scope
         plugins = PluginModel.get_all_models(scope: @name)
         plugins.each do |_plugin_name, plugin|
           plugin.destroy
         end
-        super()
+        super
       else
         raise "DEFAULT scope cannot be destroyed"
       end
     end
 
     def as_json(*_a)
-      { 'name' => @name,
-        'updated_at' => @updated_at,
-        'text_log_cycle_time' => @text_log_cycle_time,
-        'text_log_cycle_size' => @text_log_cycle_size,
-        'text_log_retain_time' => @text_log_retain_time,
-        'tool_log_retain_time' => @tool_log_retain_time,
-        'cleanup_poll_time' => @cleanup_poll_time,
-        'command_authority' => @command_authority,
-        'critical_commanding' => @critical_commanding,
-        'shard' => @shard,
-       }
+      {"name" => @name,
+       "updated_at" => @updated_at,
+       "text_log_cycle_time" => @text_log_cycle_time,
+       "text_log_cycle_size" => @text_log_cycle_size,
+       "text_log_retain_time" => @text_log_retain_time,
+       "tool_log_retain_time" => @tool_log_retain_time,
+       "cleanup_poll_time" => @cleanup_poll_time,
+       "command_authority" => @command_authority,
+       "critical_commanding" => @critical_commanding,
+       "shard" => @shard}
     end
 
     def deploy_openc3_log_messages_microservice(gem_path, variables, parent)
       microservice_name = "#{@scope}__OPENC3__LOG"
       topics = ["#{@scope}__openc3_log_messages"]
       # Also log the NOSCOPE messages with this microservice for the DEFAULT scope
-      if @scope == 'DEFAULT'
+      if @scope == "DEFAULT"
         topics << "NOSCOPE__openc3_log_messages"
       end
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "text_log_microservice.rb", microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: "/openc3/lib/openc3/microservices",
         options: [
           ["CYCLE_TIME", @text_log_cycle_time],
-          ["CYCLE_SIZE", @text_log_cycle_size],
+          ["CYCLE_SIZE", @text_log_cycle_size]
         ],
         topics: topics,
         parent: parent,
@@ -218,11 +216,11 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "log_microservice.rb", microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: "/openc3/lib/openc3/microservices",
         options: [
           ["RAW_OR_DECOM", "RAW"],
           ["CMD_OR_TLM", "CMD"],
-          ["CYCLE_TIME", "3600"], # Keep at most 1 hour per log
+          ["CYCLE_TIME", "3600"] # Keep at most 1 hour per log
         ],
         topics: ["#{@scope}__COMMAND__{UNKNOWN}__UNKNOWN"],
         target_names: [],
@@ -241,11 +239,11 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "log_microservice.rb", microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: "/openc3/lib/openc3/microservices",
         options: [
           ["RAW_OR_DECOM", "RAW"],
           ["CMD_OR_TLM", "TLM"],
-          ["CYCLE_TIME", "3600"], # Keep at most 1 hour per log
+          ["CYCLE_TIME", "3600"] # Keep at most 1 hour per log
         ],
         topics: ["#{@scope}__TELEMETRY__{UNKNOWN}__UNKNOWN"],
         target_names: [],
@@ -264,7 +262,7 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "periodic_microservice.rb", microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: "/openc3/lib/openc3/microservices",
         parent: parent,
         shard: @shard,
         scope: @scope
@@ -280,7 +278,7 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "scope_cleanup_microservice.rb", microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: "/openc3/lib/openc3/microservices",
         parent: parent,
         shard: @shard,
         scope: @scope
@@ -296,7 +294,7 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "critical_cmd_microservice.rb", microservice_name],
-        work_dir: '/openc3-enterprise/lib/openc3-enterprise/microservices',
+        work_dir: "/openc3-enterprise/lib/openc3-enterprise/microservices",
         parent: parent,
         shard: @shard,
         scope: @scope
@@ -312,7 +310,7 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "multi_microservice.rb", *@children],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: "/openc3/lib/openc3/microservices",
         target_names: [],
         shard: @shard,
         scope: @scope
@@ -323,15 +321,15 @@ module OpenC3
     end
 
     def deploy(gem_path, variables)
-      seed_database()
+      seed_database
 
       if ENTERPRISE
         # Create DEFAULT trigger group model
-        model = TriggerGroupModel.get(name: 'DEFAULT', scope: @scope)
+        model = TriggerGroupModel.get(name: "DEFAULT", scope: @scope)
         unless model
-          model = TriggerGroupModel.new(name: 'DEFAULT', shard: @shard, scope: @scope)
-          model.create()
-          model.deploy()
+          model = TriggerGroupModel.new(name: "DEFAULT", shard: @shard, scope: @scope)
+          model.create
+          model.deploy
         end
       end
 
@@ -351,7 +349,7 @@ module OpenC3
       deploy_unknown_packetlog_microservice(gem_path, variables, @parent)
 
       # Only DEFAULT scope
-      if @scope == 'DEFAULT'
+      if @scope == "DEFAULT"
         # Periodic Microservice
         deploy_periodic_microservice(gem_path, variables, @parent)
       end
@@ -403,14 +401,46 @@ module OpenC3
     end
 
     def seed_database
-      setting = SettingModel.get(name: 'source_url')
-      SettingModel.set({ name: 'source_url', data: 'https://github.com/OpenC3/cosmos' }, scope: @scope) unless setting
-      setting = SettingModel.get(name: 'rubygems_url')
-      SettingModel.set({ name: 'rubygems_url', data: ENV['RUBYGEMS_URL'] || 'https://rubygems.org' }, scope: @scope) unless setting
-      setting = SettingModel.get(name: 'pypi_url')
-      SettingModel.set({ name: 'pypi_url', data: ENV['PYPI_URL'] || 'https://pypi.org' }, scope: @scope) unless setting
+      setting = SettingModel.get(name: "source_url")
+      SettingModel.set({name: "source_url", data: "https://github.com/OpenC3/cosmos"}, scope: @scope) unless setting
+      setting = SettingModel.get(name: "rubygems_url")
+      SettingModel.set({name: "rubygems_url", data: ENV["RUBYGEMS_URL"] || "https://rubygems.org"}, scope: @scope) unless setting
+      setting = SettingModel.get(name: "pypi_url")
+      SettingModel.set({name: "pypi_url", data: ENV["PYPI_URL"] || "https://pypi.org"}, scope: @scope) unless setting
       # Set the news feed to true by default, don't bother checking if it's already set
-      SettingModel.set({ name: 'news_feed', data: true }, scope: @scope)
+      SettingModel.set({name: "news_feed", data: true}, scope: @scope)
+
+      setting = SettingModel.get(name: "system_health")
+      system_health_data = {
+        "cpu" => {
+          "redThreshold" => 90.0,
+          "yellowThreshold" => 80.0,
+          "snoozeMinutes" => 15,
+          "lastTriggerTimeRed" => nil,  # timestamp or nil
+          "lastTriggerTimeYellow" => nil,  # timestamp or nil
+          "sustainedSeconds" => 15
+        },
+        "memory" => {
+          "redThreshold" => 90.0,
+          "yellowThreshold" => 80.0,
+          "snoozeMinutes" => 15,
+          "lastTriggerTimeRed" => nil,  # timestamp or nil
+          "lastTriggerTimeYellow" => nil,  # timestamp or nil
+          "sustainedSeconds" => 15
+        },
+        "disk" => {
+          "redThreshold" => 90.0,
+          "yellowThreshold" => 80.0,
+          "snoozeMinutes" => 720,  # 12 hours
+          "lastTriggerTimeRed" => nil,  # timestamp or nil
+          "lastTriggerTimeYellow" => nil,  # timestamp or nil
+          "sustainedSeconds" => 60
+        },
+        "global" => {
+          "enableAlerts" => true
+        }
+      }
+      SettingModel.set({name: "system_health", data: system_health_data}, scope: "DEFAULT") unless setting
     end
   end
 end

data/lib/openc3/models/script_engine_model.rb

@@ -0,0 +1,93 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 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/top_level'
+require 'openc3/models/model'
+require 'openc3/models/scope_model'
+require 'openc3/utilities/bucket'
+require 'openc3/utilities/bucket_utilities'
+
+module OpenC3
+  class ScriptEngineModel < Model
+    PRIMARY_KEY = 'openc3_script_engines'
+
+    attr_accessor :filename # Script Engine filename
+
+    # NOTE: The following three class methods are used by the ModelController
+    # and are reimplemented to enable various Model class methods to work
+    def self.get(name:, scope: nil)
+      super(PRIMARY_KEY, name: name)
+    end
+
+    def self.names(scope: nil)
+      array = []
+      all(scope: scope).each do |name, _script_engine|
+        array << name
+      end
+      array
+    end
+
+    def self.all(scope: nil)
+      tools = Store.hgetall(PRIMARY_KEY)
+      tools.each do |key, value|
+        tools[key] = JSON.parse(value, :allow_nan => true, :create_additions => true)
+      end
+      return tools
+    end
+
+    # Called by the PluginModel to allow this class to validate it's top-level keyword: "SCRIPT_ENGINE"
+    def self.handle_config(parser, keyword, parameters, plugin: nil, needs_dependencies: false, scope:)
+      case keyword
+      when 'SCRIPT_ENGINE'
+        parser.verify_num_parameters(1, 3, "SCRIPT_ENGINE <Extension> <Filename>")
+        return self.new(name: parameters[0], plugin: plugin, filename: parameters[1], scope: scope)
+      else
+        raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Script Engine: #{keyword} #{parameters.join(" ")}")
+      end
+      return nil
+    end
+
+    def initialize(
+      name:,
+      updated_at: nil,
+      plugin: nil,
+      filename: nil,
+      scope:
+    )
+      super(PRIMARY_KEY, name: name, plugin: plugin, updated_at: updated_at, scope: scope)
+      @filename = filename
+    end
+
+    def as_json(*a)
+      {
+        'name' => @name,
+        'updated_at' => @updated_at,
+        'plugin' => @plugin,
+        'filename' => @filename
+      }
+    end
+
+    def handle_config(parser, keyword, parameters)
+      raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Script Engine: #{keyword} #{parameters.join(" ")}")
+    end
+
+    def deploy(gem_path, variables, validate_only: false)
+      # Nothing to do
+    end
+  end
+end

data/lib/openc3/models/script_status_model.rb

@@ -45,6 +45,7 @@ module OpenC3
     attr_accessor :pid
     attr_accessor :log
     attr_accessor :report
+    attr_accessor :script_engine
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -147,6 +148,7 @@ module OpenC3
       pid: nil,
       log: nil,
       report: nil,
+      script_engine: nil,
       updated_at: nil,
       scope:
     )
@@ -173,6 +175,7 @@ module OpenC3
       @pid = pid
       @log = log
       @report = report
+      @script_engine = script_engine
     end
 
     def is_complete?
@@ -257,6 +260,7 @@ module OpenC3
         'pid' => @pid,
         'log' => @log,
         'report' => @report,
+        'script_engine' => @script_engine,
         'updated_at' => @updated_at,
         'scope' => @scope
       }

data/lib/openc3/models/target_model.rb

@@ -676,6 +676,8 @@ module OpenC3
       LimitsEventTopic.delete(@name, scope: @scope)
       Store.del("#{@scope}__openc3tlm__#{@name}")
       Store.del("#{@scope}__openc3cmd__#{@name}")
+      Store.del("#{@scope}__TELEMETRYCNTS__{#{@name}}")
+      Store.del("#{@scope}__COMMANDCNTS__{#{@name}}")
 
       # Note: these match the names of the services in deploy_microservices
       %w(MULTI DECOM COMMANDLOG DECOMCMDLOG PACKETLOG DECOMLOG REDUCER CLEANUP).each do |type|
@@ -795,6 +797,7 @@ module OpenC3
         if clear_old
           Store.del("#{@scope}__openc3tlm__#{target_name}")
           Store.del("#{@scope}__openc3tlm__#{target_name}__allitems")
+          Store.del("#{@scope}__TELEMETRYCNTS__{#{target_name}}")
         end
         packets.each do |packet_name, packet|
           Logger.debug "Configuring tlm packet: #{target_name} #{packet_name}"
@@ -816,7 +819,10 @@ module OpenC3
 
     def update_store_commands(packet_hash, clear_old: true)
       packet_hash.each do |target_name, packets|
-        Store.del("#{@scope}__openc3cmd__#{target_name}") if clear_old
+        if clear_old
+          Store.del("#{@scope}__openc3cmd__#{target_name}")
+          Store.del("#{@scope}__COMMANDCNTS__{#{target_name}}")
+        end
         packets.each do |packet_name, packet|
           Logger.debug "Configuring cmd packet: #{target_name} #{packet_name}"
           begin

data/lib/openc3/script/script.rb

@@ -226,7 +226,11 @@ module OpenC3
     # script_run("INST/procedures/collect.rb")
     #
     def initialize_offline_access
-      auth = OpenC3KeycloakAuthentication.new(ENV['OPENC3_KEYCLOAK_URL'])
+      keycloak_url = ENV['OPENC3_KEYCLOAK_URL']
+      if keycloak_url.nil? or keycloak_url.empty?
+        raise "initialize_offline_access only valid in COSMOS Enterprise. OPENC3_KEYCLOAK_URL environment variable must be set."
+      end
+      auth = OpenC3KeycloakAuthentication.new(keycloak_url)
       auth.token(include_bearer: true, openid_scope: 'openid%20offline_access')
       set_offline_access(auth.refresh_token)
     end

data/lib/openc3/script_engines/script_engine.rb

@@ -0,0 +1,118 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 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.
+
+module OpenC3
+  class ScriptEngine
+    attr_accessor :running_script
+
+    def initialize(running_script)
+      @running_script = running_script
+    end
+
+    # Override this method in the subclass to implement the script engine
+    def run_line(line, lines, filename, line_no)
+      puts line
+      return line_no + 1
+    end
+
+    def run_text(text, filename: nil, line_no: 1, end_line_no: nil, bind_variables: false)
+      lines = text.lines
+      loop do
+        line = lines[line_no - 1]
+        return if line.nil?
+
+        begin
+          next_line_no = line_no + 1
+          running_script.pre_line_instrumentation(filename, line_no)
+          next_line_no = run_line(line, lines, filename, line_no)
+          running_script.post_line_instrumentation(filename, line_no)
+        rescue Exception => e
+          retry if running_script.exception_instrumentation(e, filename, line_no)
+        end
+
+        line_no = next_line_no
+        return if end_line_no and line_no > end_line_no
+      end
+    end
+
+    def debug(text)
+      run_line(text, [text], "DEBUG", 1)
+    end
+
+    def syntax_check(text, filename: nil)
+      puts "Not Implemented"
+      return 1
+    end
+
+    def mnemonic_check(text, filename: nil)
+      puts "Not Implemented"
+      return 1
+    end
+
+    def tokenizer(s, special_chars = '()><+-*/=;,')
+      result = []
+      i = 0
+      while i < s.length
+        # Skip whitespace
+        if s[i].match?(/\s/)
+          i += 1
+          next
+        end
+
+        # Handle quoted strings (single or double quotes)
+        if ['"', "'"].include?(s[i])
+          quote_char = s[i]
+          quote_start = i
+          i += 1
+          # Find the closing quote
+          while i < s.length
+            if s[i] == '\\' && i + 1 < s.length  # Handle escaped characters
+              i += 2
+            elsif s[i] == quote_char  # Found closing quote
+              i += 1
+              break
+            else
+              i += 1
+            end
+          end
+          # Include the quotes in the token
+          result << s[quote_start...i]
+          next
+        end
+
+        # Handle special characters
+        if special_chars.include?(s[i])
+          result << s[i]
+          i += 1
+          next
+        end
+
+        # Handle regular tokens
+        token_start = i
+        while i < s.length && !s[i].match?(/\s/) && !special_chars.include?(s[i]) && !['"', "'"].include?(s[i])
+          i += 1
+        end
+        if i > token_start
+          result << s[token_start...i]
+        end
+      end
+
+      return result
+    end
+  end
+end

data/lib/openc3/topics/interface_topic.rb

@@ -24,6 +24,8 @@ require 'openc3/topics/topic'
 
 module OpenC3
   class InterfaceTopic < Topic
+    COMMAND_ACK_TIMEOUT_S = 30
+
     # Generate a list of topics for this interface. This includes the interface itself
     # and all the targets which are assigned to this interface.
     def self.topics(interface, scope:)
@@ -48,9 +50,27 @@ module OpenC3
       end
     end
 
-    def self.write_raw(interface_name, data, scope:)
-      Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'raw' => data }, '*', 100)
-      # Todo: This should wait for the ack
+    def self.write_raw(interface_name, data, timeout: nil, scope:)
+      interface_name = interface_name.upcase
+
+      timeout = COMMAND_ACK_TIMEOUT_S unless timeout
+      ack_topic = "{#{scope}__ACKCMD}INTERFACE__#{interface_name}"
+      Topic.update_topic_offsets([ack_topic])
+
+      cmd_id = Topic.write_topic("{#{scope}__CMD}INTERFACE__#{interface_name}", { 'raw' => data }, '*', 100)
+      time = Time.now
+      while (Time.now - time) < timeout
+        Topic.read_topics([ack_topic]) do |_topic, _msg_id, msg_hash, _redis|
+          if msg_hash["id"] == cmd_id
+            if msg_hash["result"] == "SUCCESS"
+              return
+            else
+              raise msg_hash["result"]
+            end
+          end
+        end
+      end
+      raise "Timeout of #{timeout}s waiting for cmd ack"
     end
 
     def self.connect_interface(interface_name, *interface_params, scope:)