openc3 6.9.1 → 6.9.2

data/lib/openc3/models/trigger_model.rb

@@ -237,7 +237,7 @@ module OpenC3
 
     # ["#{@scope}__DECOM__{#{@target}}__#{@packet}"]
     def generate_topics
-      topics = Hash.new
+      topics = {}
       if @left['type'] == ITEM_TYPE
         topics["#{@scope}__DECOM__{#{left['target']}}__#{left['packet']}"] = 1
       end

data/lib/openc3/script/script.rb

@@ -232,7 +232,7 @@ module OpenC3
         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')
+      auth.token(include_bearer: true, openid_scope: 'openid offline_access')
       set_offline_access(auth.refresh_token)
     end
 

data/lib/openc3/system/system.rb

@@ -95,11 +95,11 @@ module OpenC3
           bucket_key = "#{scope}/target_archives/#{target_name}/#{target_name}_current.zip"
           Logger.info("Retrieving #{bucket_key} from targets bucket")
           bucket.get_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: bucket_key, path: zip_path)
+          targets_path = "#{base_dir}/targets"
+          FileUtils.mkdir_p(targets_path)
           Zip::File.open(zip_path) do |zip_file|
             zip_file.each do |entry|
-              path = File.join("#{base_dir}/targets", entry.name)
-              FileUtils.mkdir_p(File.dirname(path))
-              zip_file.extract(entry, path) unless File.exist?(path)
+              zip_file.extract(entry.name, destination_directory: targets_path)
             end
           end
 

data/lib/openc3/utilities/authentication.rb

@@ -23,6 +23,7 @@
 require 'openc3/version'
 require 'openc3/io/json_drb'
 require 'faraday'
+require 'uri'
 
 module OpenC3
   # Basic exception for known errors
@@ -112,9 +113,13 @@ module OpenC3
       client_id = ENV['OPENC3_API_CLIENT'] || 'api'
       if ENV['OPENC3_API_USER'] and ENV['OPENC3_API_PASSWORD']
         # Username and password
-        data = "username=#{ENV['OPENC3_API_USER']}&password=#{ENV['OPENC3_API_PASSWORD']}"
-        data << "&client_id=#{client_id}"
-        data << "&grant_type=password&scope=#{openid_scope}"
+        data = {
+          'username' => ENV['OPENC3_API_USER'],
+          'password' => ENV['OPENC3_API_PASSWORD'],
+          'client_id' => client_id,
+          'grant_type' => 'password',
+          'scope' => openid_scope
+        }
         headers = {
           'Content-Type' => 'application/x-www-form-urlencoded',
           'User-Agent' => "OpenC3KeycloakAuthorization / #{OPENC3_VERSION} (ruby/openc3/lib/utilities/authentication)",
@@ -134,7 +139,11 @@ module OpenC3
     # Refresh the token and save token to instance
     def _refresh_token(current_time)
       client_id = ENV['OPENC3_API_CLIENT'] || 'api'
-      data = "client_id=#{client_id}&refresh_token=#{@refresh_token}&grant_type=refresh_token"
+      data = {
+        'client_id' => client_id,
+        'refresh_token' => @refresh_token,
+        'grant_type' => 'refresh_token'
+      }
       headers = {
         'Content-Type' => 'application/x-www-form-urlencoded',
         'User-Agent' => "OpenC3KeycloakAuthorization / #{OPENC3_VERSION} (ruby/openc3/lib/utilities/authentication)",
@@ -150,11 +159,21 @@ module OpenC3
     def _make_request(headers, data)
       realm = ENV['OPENC3_KEYCLOAK_REALM'] || 'openc3'
       uri = URI("#{@url}/realms/#{realm}/protocol/openid-connect/token")
-      @log[0] = "request uri: #{uri} header: #{headers} body: #{data}"
+      # Obfuscate password and refresh token in logs unless debug mode is enabled
+      if JsonDRb.debug?
+        log_data = data.inspect
+      else
+        # Create a copy of the hash with sensitive values obfuscated
+        log_data = data.dup
+        log_data['password'] = '***' if log_data.key?('password')
+        log_data['refresh_token'] = '***' if log_data.key?('refresh_token')
+        log_data = log_data.inspect
+      end
+      @log[0] = "request uri: #{uri} header: #{headers} body: #{log_data}"
       STDOUT.puts @log[0] if JsonDRb.debug?
       saved_verbose = $VERBOSE; $VERBOSE = nil
       begin
-        resp = @http.post(uri, data, headers)
+        resp = @http.post(uri, URI.encode_www_form(data), headers)
       ensure
         $VERBOSE = saved_verbose
       end

data/lib/openc3/utilities/cli_generator.rb

@@ -18,15 +18,55 @@
 
 module OpenC3
   class CliGenerator
-    GENERATORS = %w(plugin target microservice widget conversion processor 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 command_validator)
     TEMPLATES_DIR = "#{File.dirname(__FILE__)}/../../../templates"
 
     # Called by openc3cli with ARGV[1..-1]
     def self.generate(args)
+      if args[0].nil? || args[0] == '--help' || args[0] == '-h'
+        puts "Usage: cli generate GENERATOR [ARGS...] (--ruby or --python)"
+        puts ""
+        puts "Generate COSMOS components from templates"
+        puts ""
+        puts "Available Generators:"
+        puts "  plugin                Create a new COSMOS plugin"
+        puts "  target                Create a new target within a plugin"
+        puts "  microservice          Create a new microservice within a plugin"
+        puts "  widget                Create a new custom widget"
+        puts "  conversion            Create a new conversion class for a target"
+        puts "  processor             Create a new processor for a target"
+        puts "  limits_response       Create a new limits response for a target"
+        puts "  command_validator     Create a new command validator for a target"
+        puts "  tool                  Create a new tool (Vue.js by default)"
+        puts "  tool_vue              Create a new Vue.js tool"
+        puts "  tool_angular          Create a new Angular tool"
+        puts "  tool_react            Create a new React tool"
+        puts "  tool_svelte           Create a new Svelte tool"
+        puts ""
+        puts "Run 'cli generate GENERATOR --help' for detailed help on each generator."
+        puts ""
+        puts "Options:"
+        puts "  --ruby                Generate Ruby code (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python              Generate Python code (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help            Show this help message"
+        puts ""
+        puts "Examples:"
+        puts "  cli generate plugin MyPlugin --ruby"
+        puts "  cli generate target EXAMPLE --python"
+        puts "  cli generate widget SuperdataWidget --ruby"
+        puts "  cli generate conversion EXAMPLE STATUS --ruby"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/development/developing"
+        exit(args[0].nil? ? 1 : 0)
+      end
       unless GENERATORS.include?(args[0])
         abort("Unknown generator '#{args[0]}'. Valid generators: #{GENERATORS.join(', ')}")
       end
-      check_args(args)
+      # Skip argument validation if user is requesting help
+      unless args[1] == '--help' || args[1] == '-h'
+        check_args(args)
+      end
       send("generate_#{args[0].to_s.downcase.gsub('-', '_')}", args)
     end
 
@@ -79,6 +119,29 @@ module OpenC3
     end
 
     def self.generate_plugin(args)
+      if args[1].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate plugin NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new COSMOS plugin"
+        puts ""
+        puts "Arguments:"
+        puts "  NAME              Name of the plugin (required)"
+        puts "                    Will be prefixed with 'openc3-cosmos-'"
+        puts "                    Spaces, underscores, and hyphens will be converted to hyphens"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby plugin (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python plugin (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate plugin demo --ruby"
+        puts "  Creates: openc3-cosmos-demo/"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/plugins"
+        exit(args[1].nil? ? 1 : 0)
+      end
       if args.length < 2 or args.length > 3
         abort("Usage: cli generate #{args[0]} <NAME> (--ruby or --python)")
       end
@@ -102,6 +165,30 @@ module OpenC3
     end
 
     def self.generate_target(args)
+      if args[1].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate target NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new target within an existing plugin"
+        puts ""
+        puts "Arguments:"
+        puts "  NAME              Name of the target (required)"
+        puts "                    Will be uppercased and underscores/hyphens converted to underscores"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby target (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python target (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate target EXAMPLE --ruby"
+        puts "  Creates: targets/EXAMPLE/"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/target"
+        exit(args[1].nil? ? 1 : 0)
+      end
       if args.length < 2 or args.length > 3
         abort("Usage: cli generate #{args[0]} <NAME> (--ruby or --python)")
       end
@@ -133,7 +220,17 @@ module OpenC3
         end
         gemspec_filename = Dir['*.gemspec'][0]
         gemspec = File.read(gemspec_filename)
-        gemspec.gsub!('plugin.txt', 'plugin.txt requirements.txt')
+        gemspec.gsub!(/s\.files = Dir\.glob.*\n/) do |match|
+          <<RUBY
+# Prefer pyproject.toml over requirements.txt
+  python_dep_file = if File.exist?('pyproject.toml')
+    'pyproject.toml'
+  else
+    'requirements.txt'
+  end
+  s.files = Dir.glob("{targets,lib,tools,microservices}/**/*") + %w(Rakefile README.md LICENSE.txt plugin.txt) + [python_dep_file]
+RUBY
+        end
         File.write(gemspec_filename, gemspec)
 
         target_txt_filename = "targets/#{target_name}/target.txt"
@@ -164,6 +261,30 @@ module OpenC3
     end
 
     def self.generate_microservice(args)
+      if args[1].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate microservice NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new microservice within an existing plugin"
+        puts ""
+        puts "Arguments:"
+        puts "  NAME              Name of the microservice (required)"
+        puts "                    Will be uppercased and underscores/hyphens converted to underscores"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby microservice (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python microservice (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate microservice DATA_PROCESSOR --ruby"
+        puts "  Creates: microservices/DATA_PROCESSOR/"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/plugins#microservices"
+        exit(args[1].nil? ? 1 : 0)
+      end
       if args.length < 2 or args.length > 3
         abort("Usage: cli generate #{args[0]} <NAME> (--ruby or --python)")
       end
@@ -203,6 +324,31 @@ module OpenC3
     end
 
     def self.generate_widget(args)
+      if args[1].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate widget NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new custom Vue.js widget within an existing plugin"
+        puts ""
+        puts "Arguments:"
+        puts "  NAME              Name of the widget (required)"
+        puts "                    Must be CapitalCase ending with 'Widget'"
+        puts "                    Example: SuperdataWidget, StatusWidget"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby plugin (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python plugin (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate widget SuperdataWidget --ruby"
+        puts "  Creates: src/SuperdataWidget.vue"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/guides/custom-widgets"
+        exit(args[1].nil? ? 1 : 0)
+      end
       if args.length < 2 or args.length > 3
         abort("Usage: cli generate #{args[0]} <SuperdataWidget> (--ruby or --python)")
       end
@@ -249,6 +395,75 @@ module OpenC3
     end
 
     def self.generate_tool(args)
+      if args[1].nil? || args[1] == '--help' || args[1] == '-h'
+        tool_type = args[0].to_s.downcase.gsub('-', '_')
+
+        # Specific help for tool variants
+        if tool_type != 'tool'
+          framework = case tool_type
+                      when 'tool_vue' then 'Vue.js'
+                      when 'tool_react' then 'React'
+                      when 'tool_angular' then 'Angular'
+                      when 'tool_svelte' then 'Svelte'
+                      else 'Custom'
+                      end
+
+          puts "Usage: cli generate #{args[0]} 'TOOL NAME' (--ruby or --python)"
+          puts ""
+          puts "Generate a new #{framework} tool within an existing plugin"
+          puts ""
+          puts "Arguments:"
+          puts "  TOOL NAME         Display name of the tool (required, can include spaces)"
+          puts "                    Will be converted to lowercase without spaces for directory name"
+          puts ""
+          puts "Options:"
+          puts "  --ruby            Generate Ruby plugin (or set OPENC3_LANGUAGE=ruby)"
+          puts "  --python          Generate Python plugin (or set OPENC3_LANGUAGE=python)"
+          puts "  -h, --help        Show this help message"
+          puts ""
+          puts "Example:"
+          puts "  cli generate #{args[0]} 'Data Viewer' --ruby"
+          puts "  Creates: tools/dataviewer/ (#{framework}-based)"
+          puts ""
+          puts "Note: Must be run from within an existing plugin directory"
+          puts "      For other tool types, see: cli generate tool --help"
+          puts ""
+          puts "Documentation:"
+          puts "  https://docs.openc3.com/docs/guides/custom-tools"
+          exit(args[1].nil? ? 1 : 0)
+        else
+          # Generic help showing all types
+          puts "Usage: cli generate #{args[0]} 'TOOL NAME' (--ruby or --python)"
+          puts ""
+          puts "Generate a new custom tool within an existing plugin"
+          puts ""
+          puts "Arguments:"
+          puts "  TOOL NAME         Display name of the tool (required, can include spaces)"
+          puts "                    Will be converted to lowercase without spaces for directory name"
+          puts ""
+          puts "Options:"
+          puts "  --ruby            Generate Ruby plugin (or set OPENC3_LANGUAGE=ruby)"
+          puts "  --python          Generate Python plugin (or set OPENC3_LANGUAGE=python)"
+          puts "  -h, --help        Show this help message"
+          puts ""
+          puts "Tool Types:"
+          puts "  tool              Generate Vue.js tool (default)"
+          puts "  tool_vue          Generate Vue.js tool"
+          puts "  tool_angular      Generate Angular tool"
+          puts "  tool_react        Generate React tool"
+          puts "  tool_svelte       Generate Svelte tool"
+          puts ""
+          puts "Example:"
+          puts "  cli generate tool 'Data Viewer' --ruby"
+          puts "  Creates: tools/dataviewer/"
+          puts ""
+          puts "Note: Must be run from within an existing plugin directory"
+          puts ""
+          puts "Documentation:"
+          puts "  https://docs.openc3.com/docs/guides/custom-tools"
+          exit(args[1].nil? ? 1 : 0)
+        end
+      end
       if args.length < 2 or args.length > 3
         abort("Usage: cli generate #{args[0]} 'Tool Name' (--ruby or --python)")
       end
@@ -300,6 +515,31 @@ module OpenC3
     self.singleton_class.send(:alias_method, :generate_tool_svelte, :generate_tool)
 
     def self.generate_conversion(args)
+      if args[1].nil? || args[2].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate conversion TARGET NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new conversion class for an existing target"
+        puts ""
+        puts "Arguments:"
+        puts "  TARGET            Target name (required, must exist)"
+        puts "  NAME              Conversion name (required)"
+        puts "                    Will be uppercased with '_CONVERSION' suffix"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby conversion (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python conversion (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate conversion EXAMPLE STATUS --ruby"
+        puts "  Creates: targets/EXAMPLE/lib/status_conversion.rb"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/telemetry#read_conversion"
+        exit(args[1].nil? || args[2].nil? ? 1 : 0)
+      end
       if args.length < 3 or args.length > 4
         abort("Usage: cli generate conversion <TARGET> <NAME> (--ruby or --python)")
       end
@@ -329,6 +569,31 @@ module OpenC3
     end
 
     def self.generate_processor(args)
+      if args[1].nil? || args[2].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate processor TARGET NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new processor for an existing target"
+        puts ""
+        puts "Arguments:"
+        puts "  TARGET            Target name (required, must exist)"
+        puts "  NAME              Processor name (required)"
+        puts "                    Will be uppercased with '_PROCESSOR' suffix"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby processor (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python processor (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate processor EXAMPLE DATA --ruby"
+        puts "  Creates: targets/EXAMPLE/lib/data_processor.rb"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/telemetry#processor"
+        exit(args[1].nil? || args[2].nil? ? 1 : 0)
+      end
       if args.length < 3 or args.length > 4
         abort("Usage: cli generate processor <TARGET> <NAME> (--ruby or --python)")
       end
@@ -358,6 +623,31 @@ module OpenC3
     end
 
     def self.generate_limits_response(args)
+      if args[1].nil? || args[2].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate limits_response TARGET NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new limits response for an existing target"
+        puts ""
+        puts "Arguments:"
+        puts "  TARGET            Target name (required, must exist)"
+        puts "  NAME              Limits response name (required)"
+        puts "                    Will be uppercased with '_LIMITS_RESPONSE' suffix"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby limits response (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python limits response (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate limits_response EXAMPLE CUSTOM --ruby"
+        puts "  Creates: targets/EXAMPLE/lib/custom_limits_response.rb"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/telemetry#limits_response"
+        exit(args[1].nil? || args[2].nil? ? 1 : 0)
+      end
       if args.length < 3 or args.length > 4
         abort("Usage: cli generate limits_response <TARGET> <NAME> (--ruby or --python)")
       end
@@ -385,5 +675,59 @@ module OpenC3
       puts "  LIMITS_RESPONSE #{response_basename}"
       return response_name
     end
+
+    def self.generate_command_validator(args)
+      if args[1].nil? || args[2].nil? || args[1] == '--help' || args[1] == '-h'
+        puts "Usage: cli generate command_validator TARGET NAME (--ruby or --python)"
+        puts ""
+        puts "Generate a new command validator for an existing target"
+        puts ""
+        puts "Arguments:"
+        puts "  TARGET            Target name (required, must exist)"
+        puts "  NAME              Command validator name (required)"
+        puts "                    Will be uppercased with '_COMMAND_VALIDATOR' suffix"
+        puts ""
+        puts "Options:"
+        puts "  --ruby            Generate Ruby command validator (or set OPENC3_LANGUAGE=ruby)"
+        puts "  --python          Generate Python command validator (or set OPENC3_LANGUAGE=python)"
+        puts "  -h, --help        Show this help message"
+        puts ""
+        puts "Example:"
+        puts "  cli generate command_validator EXAMPLE RANGE --ruby"
+        puts "  Creates: targets/EXAMPLE/lib/range_command_validator.rb"
+        puts ""
+        puts "Note: Must be run from within an existing plugin directory"
+        puts ""
+        puts "Documentation:"
+        puts "  https://docs.openc3.com/docs/configuration/command#validator"
+        exit(args[1].nil? || args[2].nil? ? 1 : 0)
+      end
+      if args.length < 3 or args.length > 4
+        abort("Usage: cli generate command_validator <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! Command validators must be created for existing targets.")
+      end
+      validator_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_COMMAND_VALIDATOR"
+      validator_basename = "#{validator_name.downcase}.#{@@language}"
+      validator_class = validator_basename.filename_to_class_name # NOSONAR
+      validator_filename = "targets/#{target_name}/lib/#{validator_basename}"
+      if File.exist?(validator_filename)
+        abort("Command validator #{validator_filename} already exists!")
+      end
+
+      process_template("#{TEMPLATES_DIR}/command_validator", binding) do |filename|
+        filename.sub!("command_validator.#{@@language}", validator_filename)
+        false
+      end
+
+      puts "Command validator #{validator_filename} successfully generated!"
+      puts "To use the command validator add the following to a command:"
+      puts "  VALIDATOR #{validator_basename}"
+      return validator_name
+    end
   end
 end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '6.9.1'
+OPENC3_VERSION = '6.9.2'
 module OpenC3
   module Version
     MAJOR = '6'
     MINOR = '9'
-    PATCH = '1'
+    PATCH = '2'
     OTHER = ''
-    BUILD = 'e1529f7b88799a9f85f31378db40a48b6c106899'
+    BUILD = '0b659342611ec28c5dac351032c18442820977a3'
   end
-  VERSION = '6.9.1'
-  GEM_VERSION = '6.9.1'
+  VERSION = '6.9.2'
+  GEM_VERSION = '6.9.2'
 end

data/templates/command_validator/command_validator.py

@@ -0,0 +1,49 @@
+from openc3.packets.command_validator import CommandValidator
+# Using the OpenC3 API requires the following imports:
+# from openc3.api import wait_check
+
+# Custom command validator class
+# See https://docs.openc3.com/docs/configuration/command
+class <%= validator_class %>(CommandValidator):
+    def __init__(self, *args):
+        super().__init__()
+        self.args = args
+
+    # Called before a command is sent
+    # @param command [dict] The command dictionary containing all the command details
+    # @return [list] First element is True/False/None for success/failure/unknown,
+    #   second element is an optional message string
+    def pre_check(self, command):
+        # Add your pre-command validation logic here
+        # Example:
+        # target_name = command['target_name']
+        # command_name = command['cmd_name']
+        # params = command['cmd_params']
+        # self.count = tlm("TARGET PACKET COUNT")
+        #
+        # if some_condition:
+        #     return [False, "Command validation failed: reason"]
+
+        # Return True to indicate Success, False to indicate Failure,
+        # and None to indicate Unknown. The second value is the optional message.
+        return [True, None]
+
+    # Called after a command is sent
+    # @param command [dict] The command dictionary containing all the command details
+    # @return [list] First element is True/False/None for success/failure/unknown,
+    #   second element is an optional message string
+    def post_check(self, command):
+        # Add your post-command validation logic here
+        # Example:
+        # Use the OpenC3 API to check telemetry or wait for responses
+        # wait_check("TARGET PACKET ITEM == 'EXPECTED'", 5) # Wait up to 5 seconds
+        # wait_check(f"TARGET PACKET COUNT > {self.count}", 5) # Wait up to 5 seconds
+        #
+        # if some_condition:
+        #     return [False, "Post-command validation failed: reason"]
+        #
+        # Wait for telemetry
+
+        # Return True to indicate Success, False to indicate Failure,
+        # and None to indicate Unknown. The second value is the optional message.
+        return [True, None]

data/templates/command_validator/command_validator.rb

@@ -0,0 +1,54 @@
+# encoding: ascii-8bit
+require 'openc3/packets/command_validator'
+
+module OpenC3
+  # Custom command validator class
+  # See https://docs.openc3.com/docs/configuration/command
+  class <%= validator_class %> < CommandValidator
+    def initialize(*args)
+      super()
+      @args = args
+    end
+
+    # Called before a command is sent
+    # @param command [Hash] The command hash containing all the command details
+    # @return [Array<Boolean, String>] First element is true/false/nil for success/failure/unknown,
+    #   second element is an optional message string
+    def pre_check(command)
+      # Add your pre-command validation logic here
+      # Example:
+      # target_name = command['target_name']
+      # command_name = command['cmd_name']
+      # params = command['cmd_params']
+      # @count = tlm("TARGET PACKET COUNT")
+      #
+      # if some_condition
+      #   return [false, "Command validation failed: reason"]
+      # end
+
+      # Return true to indicate Success, false to indicate Failure,
+      # and nil to indicate Unknown. The second value is the optional message.
+      return [true, nil]
+    end
+
+    # Called after a command is sent
+    # @param command [Hash] The command hash containing all the command details
+    # @return [Array<Boolean, String>] First element is true/false/nil for success/failure/unknown,
+    #   second element is an optional message string
+    def post_check(command)
+      # Add your post-command validation logic here
+      # Example:
+      # Use the OpenC3 API to check telemetry or wait for responses
+      # wait_check("TARGET PACKET ITEM == 'EXPECTED'", 5) # Wait up to 5 seconds
+      # wait_check("TARGET PACKET COUNT > #{@count}", 5) # Wait up to 5 seconds
+      #
+      # if some_condition
+      #   return [false, "Post-command validation failed: reason"]
+      # end
+
+      # Return true to indicate Success, false to indicate Failure,
+      # and nil to indicate Unknown. The second value is the optional message.
+      return [true, nil]
+    end
+  end
+end