openc3 6.4.1 → 6.5.0

data/lib/openc3/script/autonomic.rb

@@ -0,0 +1,359 @@
+# 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
+  module Script
+    private
+
+    # Group Methods
+    def autonomic_group_list(scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/group"
+        response = $api_server.request('get', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          raise "Unexpected response to autonomic_group_list: #{response.inspect}"
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_group_list failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_group_create(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/group"
+        response = $api_server.request('post', endpoint, data: { name: name }, json: true, scope: scope)
+        if response.nil? || response.status != 201
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_group_create error: #{parsed['message']}"
+          else
+            raise "autonomic_group_create failed"
+          end
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_group_create failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_group_show(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/group/#{name}"
+        response = $api_server.request('get', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          raise "Unexpected response to autonomic_group_show: #{response.inspect}"
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_group_show failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_group_destroy(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/group/#{name}"
+        response = $api_server.request('delete', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_group_destroy error: #{parsed['error']}"
+          else
+            raise "autonomic_group_destroy failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_group_destroy failed due to #{error.formatted}"
+      end
+    end
+
+    # Trigger Methods
+    def autonomic_trigger_list(group: 'DEFAULT', scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger"
+        response = $api_server.request('get', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          raise "Unexpected response to autonomic_trigger_list: #{response.inspect}"
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_trigger_list failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_trigger_create(left:, operator:, right:, group: 'DEFAULT', scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger"
+        config = {
+          'group' => group,
+          'left' => left,
+          'operator' => operator,
+          'right' => right
+        }
+        response = $api_server.request('post', endpoint, data: config, json: true, scope: scope)
+        if response.nil? || response.status != 201
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_trigger_create error: #{parsed['error']}"
+          else
+            raise "autonomic_trigger_create failed"
+          end
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_trigger_create failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_trigger_show(name, group: 'DEFAULT', scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger/#{name}"
+        response = $api_server.request('get', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          raise "Unexpected response to autonomic_trigger_show: #{response.inspect}"
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_trigger_show failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_trigger_enable(name, group: 'DEFAULT', scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger/#{name}/enable"
+        response = $api_server.request('post', endpoint, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_trigger_enable error: #{parsed['error']}"
+          else
+            raise "autonomic_trigger_enable failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_trigger_enable failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_trigger_disable(name, group: 'DEFAULT', scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger/#{name}/disable"
+        response = $api_server.request('post', endpoint, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_trigger_disable error: #{parsed['error']}"
+          else
+            raise "autonomic_trigger_disable failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_trigger_disable failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_trigger_update(name, group: 'DEFAULT', left: nil, operator: nil, right: nil, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger/#{name}"
+        config = {}
+        config['left'] = left if left
+        config['operator'] = operator if operator
+        config['right'] = right if right
+        response = $api_server.request('put', endpoint, data: config, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_trigger_update error: #{parsed['error']}"
+          else
+            raise "autonomic_trigger_update failed"
+          end
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_trigger_update failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_trigger_destroy(name, group: 'DEFAULT', scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/#{group}/trigger/#{name}"
+        response = $api_server.request('delete', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_trigger_destroy error: #{parsed['error']}"
+          else
+            raise "autonomic_trigger_destroy failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_trigger_destroy failed due to #{error.formatted}"
+      end
+    end
+
+    # Reaction Methods
+    def autonomic_reaction_list(scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction"
+        response = $api_server.request('get', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          raise "Unexpected response to autonomic_reaction_list: #{response.inspect}"
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_reaction_list failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_create(triggers:, actions:, trigger_level: 'EDGE', snooze: 0, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction"
+        config = {
+          'triggers' => triggers,
+          'actions' => actions,
+          'trigger_level' => trigger_level,
+          'snooze' => snooze,
+        }
+        response = $api_server.request('post', endpoint, data: config, json: true, scope: scope)
+        if response.nil? || response.status != 201
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_reaction_create error: #{parsed['error']}"
+          else
+            raise "autonomic_reaction_create failed"
+          end
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_reaction_create failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_show(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction/#{name}"
+        response = $api_server.request('get', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          raise "Unexpected response to autonomic_reaction_show: #{response.inspect}"
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_reaction_show failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_enable(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction/#{name}/enable"
+        response = $api_server.request('post', endpoint, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_reaction_enable error: #{parsed['error']}"
+          else
+            raise "autonomic_reaction_enable failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_reaction_enable failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_disable(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction/#{name}/disable"
+        response = $api_server.request('post', endpoint, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_reaction_disable error: #{parsed['error']}"
+          else
+            raise "autonomic_reaction_disable failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_reaction_disable failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_execute(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction/#{name}/execute"
+        response = $api_server.request('post', endpoint, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_reaction_execute error: #{parsed['error']}"
+          else
+            raise "autonomic_reaction_execute failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_reaction_execute failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_update(name, triggers: nil, actions: nil, trigger_level: nil, snooze: nil, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction/#{name}"
+        config = {}
+        config['triggers'] = triggers if triggers
+        config['actions'] = actions if actions
+        config['trigger_level'] = trigger_level if trigger_level
+        config['snooze'] = snooze if snooze
+        response = $api_server.request('put', endpoint, data: config, json: true, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_reaction_update error: #{parsed['error']}"
+          else
+            raise "autonomic_reaction_update failed"
+          end
+        end
+        return JSON.parse(response.body)
+      rescue => error
+        raise "autonomic_reaction_update failed due to #{error.formatted}"
+      end
+    end
+
+    def autonomic_reaction_destroy(name, scope: $openc3_scope)
+      begin
+        endpoint = "/openc3-api/autonomic/reaction/#{name}"
+        response = $api_server.request('delete', endpoint, scope: scope)
+        if response.nil? || response.status != 200
+          if response
+            parsed = JSON.parse(response.body)
+            raise "autonomic_reaction_destroy error: #{parsed['error']}"
+          else
+            raise "autonomic_reaction_destroy failed"
+          end
+        end
+        return
+      rescue => error
+        raise "autonomic_reaction_destroy failed due to #{error.formatted}"
+      end
+    end
+  end
+end

data/lib/openc3/script/script.rb

@@ -24,6 +24,7 @@ require 'openc3'
 require 'openc3/api/api'
 require 'openc3/io/json_drb_object'
 require 'openc3/script/api_shared'
+require 'openc3/script/autonomic'
 require 'openc3/script/calendar'
 require 'openc3/script/commands'
 require 'openc3/script/critical_cmd'
@@ -225,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:)

data/lib/openc3/utilities/cli_generator.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2024 OpenC3, Inc.
+# Copyright 2025 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -18,7 +18,7 @@
 
 module OpenC3
   class CliGenerator
-    GENERATORS = %w(plugin target microservice widget conversion limits_response tool tool_vue tool_angular tool_react tool_svelte)
+    GENERATORS = %w(plugin target microservice widget conversion processor limits_response tool tool_vue tool_angular tool_react tool_svelte)
     TEMPLATES_DIR = "#{File.dirname(__FILE__)}/../../../templates"
 
     # Called by openc3cli with ARGV[1..-1]
@@ -32,8 +32,8 @@ module OpenC3
 
     def self.check_args(args)
       args.each do |arg|
-        if arg =~ /\s/
-          abort("#{args[0].to_s.downcase} arguments can not have spaces!") unless args[0].to_s.downcase[0..3] == 'tool'
+        if arg =~ /\s/ and args[0].to_s.downcase[0..3] != 'tool'
+          abort("#{args[0].to_s.downcase} arguments can not have spaces!")
         end
       end
       # All generators except 'plugin' must be within an existing plugin
@@ -58,12 +58,12 @@ module OpenC3
     def self.process_template(template_dir, the_binding)
       Dir.glob("#{template_dir}/**/*", File::FNM_DOTMATCH).each do |file|
         next if File.basename(file) == '.'
-        if @@language == 'rb'
+        if @@language == 'rb' and File.extname(file) == '.py'
           # Ignore python files if we're ruby
-          next if File.extname(file) == '.py'
-        elsif @@language == 'py'
+          next
+        elsif @@language == 'py' and File.extname(file) == '.rb'
           # Ignore ruby files if we're python
-          next if File.extname(file) == '.rb'
+          next
         end
         base_name = file.sub("#{template_dir}/", '')
         next if yield base_name
@@ -113,8 +113,8 @@ module OpenC3
         abort("Target #{target_path} already exists!")
       end
       target_lib_filename = "#{target_name.downcase}.#{@@language}"
-      target_class = target_lib_filename.filename_to_class_name
-      target_object = target_name.downcase
+      target_class = target_lib_filename.filename_to_class_name # NOSONAR
+      target_object = target_name.downcase # NOSONAR
 
       process_template("#{TEMPLATES_DIR}/target", binding) do |filename|
         # Rename the template TARGET to our actual target named after the plugin
@@ -175,7 +175,7 @@ module OpenC3
         abort("Microservice #{microservice_path} already exists!")
       end
       microservice_filename = "#{microservice_name.downcase}.#{@@language}"
-      microservice_class = microservice_filename.filename_to_class_name
+      microservice_class = microservice_filename.filename_to_class_name # NOSONAR
 
       process_template("#{TEMPLATES_DIR}/microservice", binding) do |filename|
         # Rename the template MICROSERVICE to our actual microservice name
@@ -310,9 +310,8 @@ module OpenC3
         abort("Target '#{target_name}' does not exist! Conversions must be created for existing targets.")
       end
       conversion_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_CONVERSION"
-      conversion_path = "targets/#{target_name}/lib/"
       conversion_basename = "#{conversion_name.downcase}.#{@@language}"
-      conversion_class = conversion_basename.filename_to_class_name
+      conversion_class = conversion_basename.filename_to_class_name # NOSONAR
       conversion_filename = "targets/#{target_name}/lib/#{conversion_basename}"
       if File.exist?(conversion_filename)
         abort("Conversion #{conversion_filename} already exists!")
@@ -329,6 +328,35 @@ module OpenC3
       return conversion_name
     end
 
+    def self.generate_processor(args)
+      if args.length < 3 or args.length > 4
+        abort("Usage: cli generate processor <TARGET> <NAME> (--ruby or --python)")
+      end
+
+      # Create the local variables
+      target_name = args[1].upcase
+      unless File.exist?("targets/#{target_name}")
+        abort("Target '#{target_name}' does not exist! Processors must be created for existing targets.")
+      end
+      processor_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_PROCESSOR"
+      processor_basename = "#{processor_name.downcase}.#{@@language}"
+      processor_class = processor_basename.filename_to_class_name # NOSONAR
+      processor_filename = "targets/#{target_name}/lib/#{processor_basename}"
+      if File.exist?(processor_filename)
+        abort("Processor #{processor_filename} already exists!")
+      end
+
+      process_template("#{TEMPLATES_DIR}/processor", binding) do |filename|
+        filename.sub!("processor.#{@@language}", processor_filename)
+        false
+      end
+
+      puts "Processor #{processor_filename} successfully generated!"
+      puts "To use the processor add the following to a telemetry packet:"
+      puts "  PROCESSOR #{args[2].upcase} #{processor_basename} <PARAMS...>"
+      return processor_name
+    end
+
     def self.generate_limits_response(args)
       if args.length < 3 or args.length > 4
         abort("Usage: cli generate limits_response <TARGET> <NAME> (--ruby or --python)")
@@ -340,10 +368,9 @@ module OpenC3
         abort("Target '#{target_name}' does not exist! Limits responses must be created for existing targets.")
       end
       response_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_LIMITS_RESPONSE"
-      response_path = "targets/#{target_name}/lib/"
       response_basename = "#{response_name.downcase}.#{@@language}"
-      response_class = response_basename.filename_to_class_name
       response_filename = "targets/#{target_name}/lib/#{response_basename}"
+      response_class = response_basename.filename_to_class_name # NOSONAR
       if File.exist?(response_filename)
         abort("response #{response_filename} already exists!")
       end